AppearanceElement
extends Element
in package
Element responsible for drawing the screen used to set up the search engine appearance.
Tags
Table of Contents
- $view : object
- The View on which this Element is drawn
- __construct() : mixed
- constructor stores a reference to the view this element will reside on
- formatHref() : string
- Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)
- render() : mixed
- Draws the forms used to modify the search engine appearance.
- renderMainAppearanceForm() : mixed
- Used to draw general appearance controls for a Yioop site such as for setting the background color, site logo, etc.
- renderThemeForm() : mixed
- Used to draw the create/edit theme forms for the Appearance Acitivity
Properties
$view
The View on which this Element is drawn
public
object
$view
Methods
__construct()
constructor stores a reference to the view this element will reside on
public
__construct([object $view = null ]) : mixed
Parameters
- $view : object = null
-
object this element will reside on
Return values
mixed —formatHref()
Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)
public
formatHref(string $url) : string
Parameters
- $url : string
-
to clean up
Return values
string —cleaned url
render()
Draws the forms used to modify the search engine appearance.
public
render(array<string|int, mixed> $data) : mixed
This element has a form to set foreground, background appearance and icons used in the display of the Yioop web app. It can also be used to configure if the main landing page should be the main wiki page
Parameters
- $data : array<string|int, mixed>
-
holds data on the profile elements related to site appearance
Return values
mixed —renderMainAppearanceForm()
Used to draw general appearance controls for a Yioop site such as for setting the background color, site logo, etc.
public
renderMainAppearanceForm(array<string|int, mixed> $data) : mixed
Has a drop down for setting the current theme, but does not show the edit/add theme forms.
Parameters
- $data : array<string|int, mixed>
-
from the AdminController/SystemComponent with the current values for appearance settings.
Return values
mixed —renderThemeForm()
Used to draw the create/edit theme forms for the Appearance Acitivity
public
renderThemeForm(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
from the AdminController/SystemComponent with the code for the theme being edited