LayoutHelper
in package
Class LayoutHelper
Table of Contents
Methods
- getAdminFooter() : string|null
- Prints Admin Footer
- getAdminHeader() : string|null
- Prints Admin Header
- loadEndScripts() : bool|string|array<string|int, string>|null
- notifications() : mixed
- Display notifications
- renderSurveySidemenu() : mixed
- Show side menu for survey view
- renderTopbarTemplate() : mixed
- showadminmenu() : string
- This is the topbar for the whole application consiting of: -- Create survey (link) -- Surveys -- Help -- Configuration (collapse menu items e.g. 'Usermanagement', 'Dashboard') -- Notifications -- admin _showadminmenu() function returns html text for the administration button bar
- showHeaders() : mixed
- Header (html header)
- updatenotification() : mixed
- Display the update notification
- beforeSideMenuRender() : string
- Returns content from event beforeSideMenuRender
- fetchExtraMenus() : array<string|int, ExtraMenu>
- Get extra menus from plugins that are using event beforeAdminMenuRender
- renderQuickmenu() : string
- Render the quick-menu that is shown when side-menu is hidden.
Methods
getAdminFooter()
Prints Admin Footer
public
getAdminFooter(string $url[, bool $return = false ][, bool $questionEditor = false ]) : string|null
Parameters
- $url : string
- $return : bool = false
- $questionEditor : bool = false
-
if footer is on question editor layout page
Tags
Return values
string|nullgetAdminHeader()
Prints Admin Header
public
getAdminHeader([bool $meta = false ][, bool $return = false ]) : string|null
Parameters
- $meta : bool = false
- $return : bool = false
Tags
Return values
string|nullloadEndScripts()
public
loadEndScripts() : bool|string|array<string|int, string>|null
Return values
bool|string|array<string|int, string>|nullnotifications()
Display notifications
public
notifications() : mixed
renderSurveySidemenu()
Show side menu for survey view
public
renderSurveySidemenu(array<string|int, mixed> $aData) : mixed
Parameters
- $aData : array<string|int, mixed>
-
all the needed data
renderTopbarTemplate()
public
renderTopbarTemplate(mixed $aData) : mixed
Parameters
- $aData : mixed
showadminmenu()
This is the topbar for the whole application consiting of: -- Create survey (link) -- Surveys -- Help -- Configuration (collapse menu items e.g. 'Usermanagement', 'Dashboard') -- Notifications -- admin _showadminmenu() function returns html text for the administration button bar
public
showadminmenu( $aData) : string
Parameters
Tags
Return values
stringshowHeaders()
Header (html header)
public
showHeaders(array<string|int, mixed> $aData[, bool $sendHTTPHeader = true ]) : mixed
Parameters
- $aData : array<string|int, mixed>
- $sendHTTPHeader : bool = true
updatenotification()
Display the update notification
public
updatenotification() : mixed
Tags
beforeSideMenuRender()
Returns content from event beforeSideMenuRender
protected
beforeSideMenuRender(array<string|int, mixed> $aData) : string
Parameters
- $aData : array<string|int, mixed>
Return values
stringfetchExtraMenus()
Get extra menus from plugins that are using event beforeAdminMenuRender
protected
fetchExtraMenus(array<string|int, mixed> $aData) : array<string|int, ExtraMenu>
Parameters
- $aData : array<string|int, mixed>
Return values
array<string|int, ExtraMenu>renderQuickmenu()
Render the quick-menu that is shown when side-menu is hidden.
protected
renderQuickmenu(array<string|int, mixed> $aData) : string
Only show home-icon for now.
Add support for plugin to attach icon elements using event afterQuickMenuLoad
Parameters
- $aData : array<string|int, mixed>