LimeSurvey API - Master branch

LayoutHelper
in package

Class LayoutHelper

Table of Contents

Methods

getAdminFooter()  : string|null
Prints Admin Footer
getAdminHeader()  : string|null
Prints Admin Header
getCreateMenu()  : Menu
Returns extra menu for the new create process (including create, copy, and import survey).
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 consisting 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()  : string|void
Display the update notification bar.
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
access

protected

Return values
string|null

getAdminHeader()

Prints Admin Header

public getAdminHeader([bool $meta = false ][, bool $return = false ][, array<string|int, mixed> $pageData = [] ]) : string|null
Parameters
$meta : bool = false
$return : bool = false
$pageData : array<string|int, mixed> = []

Optional page data (e.g. topbar, title_bar) to set document title for screen readers

Tags
access

protected

Return values
string|null

getCreateMenu()

Returns extra menu for the new create process (including create, copy, and import survey).

public getCreateMenu() : Menu
Return values
Menu

loadEndScripts()

public loadEndScripts() : bool|string|array<string|int, string>|null
Return values
bool|string|array<string|int, string>|null

notifications()

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 consisting 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
$aData :
Tags
access

public

throws
CException
global

string $scriptname

global

string $surveyid

global

string $setfont

global

string $imageurl

global

int $surveyid

global

string $homedir

Return values
string

showHeaders()

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 bar.

public updatenotification() : string|void

Passes security_update_available and stability_labels to the notification view.

Tags
throws
CException
Return values
string|void —

Rendered notification HTML, or void if no update

beforeSideMenuRender()

Returns content from event beforeSideMenuRender

protected beforeSideMenuRender(array<string|int, mixed> $aData) : string
Parameters
$aData : array<string|int, mixed>
Return values
string

fetchExtraMenus()

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>
Tags
todo

Make quick-menu user configurable

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results