SurveyController
extends LSYii_Controller
in package
Table of Contents
Properties
- $aGlobalData : array<string|int, mixed>
- $aReplacementData : array<string|int, string>
- $lang : string|null
- $layout : string
- $navData : array<string|int, mixed>
- This array contains the survey / group / question id used by the menu widget.
- $sTemplate : string|null
Methods
- __construct() : mixed
- Basic initialiser to the base controller class
- actions() : array<string|int, mixed>
- Routes all the actions to their respective places
- createAbsoluteUrl() : string
- Returns an absolute URL based on the given controller and action information.
- loadHelper() : void
- Loads a helper
- loadLibrary() : void
- Loads a library
- renderExitMessage() : void
- Show a message and exit
- _checkInstallation() : void
- Check that installation was already done by looking for config.php Will redirect to the installer script if not exists.
- customInit() : void
- Initialises this controller, does some basic checks and setups
- loadPageStates() : array<string|int, mixed>
- Loads page states from a hidden input.
- sessioncontrol() : void
- Load and set session vars
Properties
$aGlobalData
public
array<string|int, mixed>
$aGlobalData
= array()
Global data when use templatereplace function in layout, @see templatereplace $redata
$aReplacementData
public
array<string|int, string>
$aReplacementData
= array()
Replacement data when use templatereplace function in layout, @see templatereplace $replacements
$lang
public
string|null
$lang
= \null
$layout
public
string
$layout
= 'bare'
Default layout when using render : leave at bare actually : just send content
$navData
This array contains the survey / group / question id used by the menu widget.
public
array<string|int, mixed>
$navData
= array()
$sTemplate
public
string|null
$sTemplate
= \null
the template name to be used when using layout
Methods
__construct()
Basic initialiser to the base controller class
public
__construct(string $id[, CWebModule $module = null ]) : mixed
Parameters
- $id : string
- $module : CWebModule = null
Tags
actions()
Routes all the actions to their respective places
public
actions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>createAbsoluteUrl()
Returns an absolute URL based on the given controller and action information.
public
createAbsoluteUrl(string $route[, array<string|int, mixed> $params = array() ][, string $schema = '' ][, string $ampersand = '&' ]) : string
The functionalty was moved to \LSYii_Application::createPublicUrl, to be safe the function remains here.
Parameters
- $route : string
-
the URL route. This should be in the format of 'ControllerID/ActionID'.
- $params : array<string|int, mixed> = 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.
Return values
string —the constructed URL
loadHelper()
Loads a helper
public
loadHelper(string $helper) : void
Parameters
- $helper : string
Tags
loadLibrary()
Loads a library
public
loadLibrary(string $library) : void
Parameters
- $library : string
Tags
renderExitMessage()
Show a message and exit
public
renderExitMessage(int $iSurveyId, string $sType[, array<string|int, string> $aMessages = array() ][, array<string|int, string>|null $aUrl = null ][, array<string|int, string>|null $aErrors = null ]) : void
Parameters
- $iSurveyId : int
-
: type of message
- $sType : string
-
: type of message
- $aMessages : array<string|int, string> = array()
-
: array of message line to be shown
- $aUrl : array<string|int, string>|null = null
-
: if url can/must be set
- $aErrors : array<string|int, string>|null = null
-
: array of errors to be shown
_checkInstallation()
Check that installation was already done by looking for config.php Will redirect to the installer script if not exists.
protected
_checkInstallation() : void
Tags
customInit()
Initialises this controller, does some basic checks and setups
protected
customInit() : void
Tags
loadPageStates()
Loads page states from a hidden input.
protected
loadPageStates() : array<string|int, mixed>
Return values
array<string|int, mixed> —the loaded page states
sessioncontrol()
Load and set session vars
protected
sessioncontrol() : void