LimeSurvey API - Master branch
Back to top  

LayoutHelper

package

Default

Methods

Shows a message box

_showMessageBox(string $title,string $message,string $class = "message-box-error",boolean $return = false): string|null
access

public
Throws
\CException

Arguments

$title

string

$message

string

$class

string

$return

boolean

Response

string|null

Show survey summary

_surveysummary(array $aData)

todo: here are to many things that should be done in controller ...

Arguments

$aData

array

Returns content from event beforeSideMenuRender

beforeSideMenuRender(array $aData): string

Arguments

$aData

array

Response

string

Get extra menus from plugins that are using event beforeAdminMenuRender

fetchExtraMenus(array $aData): \array<ExtraMenu>

Arguments

$aData

array

Response

\array

Renders specific button bar with buttons like (saveBtn, saveAndCloseBtn, closeBtn) If rendered or not depends on aData['fullpagebar'] is set to true in a specific action

fullpagebar( $aData)
Throws
\CException

Arguments

$aData

Prints Admin Footer

getAdminFooter(string $url,boolean $return = false): string|null
access

protected

Arguments

$url

string

$return

boolean

Response

string|null

Prints Admin Header

getAdminHeader(boolean $meta = false,boolean $return = false): string|null
access

protected
Throws
\CException

Arguments

$meta

boolean

$return

boolean

Response

string|null

loadEndScripts

loadEndScripts(): boolean|string|array<mixed,string>|null
Throws
\CException

Response

boolean|string|array<mixed,string>|null

Display notifications

notifications()

renderGeneraltopbar

renderGeneraltopbar( $aData)

Arguments

$aData

todo: document me.

renderGeneralTopbarAdditions( $aData)

..

Arguments

$aData

listquestion groups

renderListQuestionGroups(array $aData)

Arguments

$aData

array

renderListQuestions

renderListQuestions( $aData)
Throws
\CException

Arguments

$aData

This is for rendering a particular Menubar (e.g. the userGroupBar)

renderMenuBar( $aData)
Throws
\CException

Arguments

$aData

Render the save/cancel bar for Organize question groups/questions

renderOrganizeQuestionBar(array $aData)
since 2014-09-30
author

Olle Haerstedt

Arguments

$aData

array

Render the quick-menu that is shown when side-menu is hidden.

renderQuickmenu(array $aData): string

Only show home-icon for now.

Add support for plugin to attach icon elements using event afterQuickMenuLoad

todo

Make quick-menu user configurable

Arguments

$aData

array

Response

string

Show side menu for survey view

renderSurveySidemenu(array $aData)

Arguments

$aData

array

all the needed data

Survey summary

renderSurveySummary(array $aData)

Arguments

$aData

array

Renders the titlebar of question editor page

rendertitlebar( $aData)

Arguments

$aData

_showadminmenu() function returns html text for the administration button bar

showadminmenu( $aData): string
access

public
global

string $scriptname

string $surveyid

string $setfont

string $imageurl

int $surveyid

string $homedir
Throws
\CException

Arguments

$aData

Response

string

Header

showHeaders(array $aData, $sendHTTPHeader = true)

Arguments

$aData

array

$sendHTTPHeader

Display the update notification

updatenotification()