RegisterController
extends LSYii_Controller
in package
register
Tags
Table of Contents
Properties
- $aGlobalData : mixed
- $aReplacementData : mixed
- $layout : mixed
- $navData : array<string|int, mixed>
- This array contains the survey / group / question id used by the menu widget.
- $sTemplate : mixed
- $aRegisterErrors : mixed
- The array of errors to be displayed
- $sMailMessage : mixed
- The message to diplay after sending the register email
- $sMessage : mixed
- The message to be shown, is not null: default form not shown
Methods
- __construct() : mixed
- Basic initialiser to the base controller class
- actionAJAXRegisterForm() : mixed
- actionIndex() : void
- Default action register Process register form data and take appropriate action
- actions() : mixed
- createAbsoluteUrl() : string
- Returns an absolute URL based on the given controller and action information.
- getExtraAttributeInfo() : array<string|int, mixed>
- Get the array of extra attribute with caption
- getFieldValue() : array<string|int, mixed>
- Get the array of fill value from the register form
- getRegisterErrors() : array<string|int, mixed>
- Validate a register form
- getRegisterForm() : array<string|int, mixed>
- Create the array to render the registration form Takes eventual changes through plugins into account
- getRegisterSuccess() : array<string|int, mixed>
- Creates the array for the registration success page
- getStartDate() : null|string
- Get the date if survey is future
- getTokenId() : int
- Get the token id according to filled values
- loadHelper() : void
- Loads a helper
- loadLibrary() : void
- Loads a library
- sendRegistrationEmail() : bool
- Send the register email with $_POST value
- _checkInstallation() : void
- Check that installation was already done by looking for config.php Will redirect to the installer script if not exists.
- customInit() : mixed
- loadPageStates() : array<string|int, mixed>
- Loads page states from a hidden input.
- display() : mixed
- Display needed public page
Properties
$aGlobalData
public
mixed
$aGlobalData
= array()
$aReplacementData
public
mixed
$aReplacementData
= array()
$layout
public
mixed
$layout
= 'survey'
$navData
This array contains the survey / group / question id used by the menu widget.
public
array<string|int, mixed>
$navData
= array()
$sTemplate
public
mixed
$sTemplate
$aRegisterErrors
The array of errors to be displayed
private
mixed
$aRegisterErrors
$sMailMessage
The message to diplay after sending the register email
private
mixed
$sMailMessage
$sMessage
The message to be shown, is not null: default form not shown
private
mixed
$sMessage
Methods
__construct()
Basic initialiser to the base controller class
public
__construct(string $id[, CWebModule $module = null ]) : mixed
Parameters
- $id : string
- $module : CWebModule = null
Tags
actionAJAXRegisterForm()
public
actionAJAXRegisterForm(mixed $surveyid) : mixed
Parameters
- $surveyid : mixed
actionIndex()
Default action register Process register form data and take appropriate action
public
actionIndex([ $sid = null ]) : void
Parameters
actions()
public
actions() : 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
getExtraAttributeInfo()
Get the array of extra attribute with caption
public
getExtraAttributeInfo( $iSurveyId) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed>getFieldValue()
Get the array of fill value from the register form
public
getFieldValue( $iSurveyId) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —: if email is set to sent (before SMTP problem)
getRegisterErrors()
Validate a register form
public
getRegisterErrors( $iSurveyId) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —of errors when try to register (empty array => no error)
getRegisterForm()
Create the array to render the registration form Takes eventual changes through plugins into account
public
getRegisterForm(int $iSurveyId) : array<string|int, mixed>
Parameters
- $iSurveyId : int
-
The surey id
Return values
array<string|int, mixed> —The rendereable array
getRegisterSuccess()
Creates the array for the registration success page
public
getRegisterSuccess(int $iSurveyId, int $iTokenId) : array<string|int, mixed>
Parameters
- $iSurveyId : int
-
The survey ID
- $iTokenId : int
-
The token id
Return values
array<string|int, mixed> —The rendereable array
getStartDate()
Get the date if survey is future
public
getStartDate(int $iSurveyId) : null|string
Parameters
- $iSurveyId : int
Return values
null|string —date
getTokenId()
Get the token id according to filled values
public
getTokenId( $iSurveyId) : int
Parameters
Return values
int —: the token id created
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
sendRegistrationEmail()
Send the register email with $_POST value
public
sendRegistrationEmail( $iSurveyId, mixed $iTokenId) : bool
Parameters
Return values
bool —: if email is set to sent (before SMTP problem)
_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()
protected
customInit() : mixed
loadPageStates()
Loads page states from a hidden input.
protected
loadPageStates() : array<string|int, mixed>
Return values
array<string|int, mixed> —the loaded page states
display()
Display needed public page
private
display( $iSurveyId, mixed $iTokenId, string $registerContent) : mixed