LimeSurvey API - Master branch
Back to top  

SurveyController

Extends\LSYii_Controller

package

Default

Methods

Basic initialiser to the base controller class

__construct(string $id,\CWebModule $module = null)
inherited
access

public

Arguments

$id

string

$module

\CWebModule

Check that installation was already done by looking for config.php Will redirect to the installer script if not exists.

_checkInstallation(): void
inherited
access

protected

Routes all the actions to their respective places

actions(): array
access

public

Response

array

Creates an absolute URL based on the given controller and action information.

createAbsoluteUrl(string $route,array $params = array(),string $schema = '',string $ampersand = '&'): string
inherited

Arguments

$route

string

the URL route. This should be in the format of 'ControllerID/ActionID'.

$params

array

additional GET parameters (name=>value). Both the name and value will be URL-encoded.

$schema

string

schema to use (e.g. http, https). If empty, the schema used for the current request will be used.

$ampersand

string

the token separating name-value pairs in the URL.

Response

string

the constructed URL

customInit

customInit()
inherited

Loads a helper

loadHelper(string $helper): void
inherited
access

public

Arguments

$helper

string

Loads a library

loadLibrary(string $library): void
inherited
access

public

Arguments

$library

string

Loads page states from a hidden input.

loadPageStates(): array
inherited

Response

array

the loaded page states

Show a message and exit

renderExitMessage(integer $iSurveyId,string $sType,array<mixed,string> $aMessages = array(),array<mixed,string>|null $aUrl = null,array<mixed,string>|null $aErrors = null): void

Arguments

$iSurveyId

integer

: type of message

$sType

string

: type of message

$aMessages

array<mixed,string>

: array of message line to be shown

$aUrl

array<mixed,string>|null

: if url can/must be set

$aErrors

array<mixed,string>|null

: array of errors to be shown

Load and set session vars

sessioncontrol(): void
access

protected

Properties

lang

lang :string|null
var

Type(s)

string|null

Default layout when using render : leave at bare actually : just send content

layout :string
var

Default layout when using render : leave at bare actually : just send content

Type(s)

string

the template name to be used when using layout

sTemplate :string|null
var

the template name to be used when using layout

Type(s)

string|null

Replacement data when use templatereplace function in layout, @see templatereplace $replacements

aReplacementData :array<mixed,string>
var

Replacement data when use templatereplace function in layout, @see templatereplace $replacements

Type(s)

array<mixed,string>

Global data when use templatereplace function in layout, @see templatereplace $redata

aGlobalData :array
var

Global data when use templatereplace function in layout, @see templatereplace $redata

Type(s)

array

This array contains the survey / group / question id used by the menu widget.

navData :array
inherited
var

Type(s)

array