LimeSurvey API - Master branch
Back to top  

RegisterController

Extends\LSYii_Controller

register

package

LimeSurvey
copyright

2011
access

public

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

actionAJAXRegisterForm

actionAJAXRegisterForm( $surveyid)

Arguments

$surveyid

Default action register Process register form data and take appropriate action

actionIndex( $sid = null):

Arguments

$sid

Survey Id to register

Response

actions

actions()

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

Display needed public page

display( $iSurveyId, $iTokenId,string $registerContent)

Arguments

$iSurveyId

$iTokenId

$registerContent

string

Get the array of extra attribute with caption

getExtraAttributeInfo( $iSurveyId): array

Arguments

$iSurveyId

Response

array

Get the array of fill value from the register form

getFieldValue( $iSurveyId): array

Arguments

$iSurveyId

Response

array

: if email is set to sent (before SMTP problem)

Validate a register form

getRegisterErrors( $iSurveyId): array

Arguments

$iSurveyId

Survey Id to register

Response

array

of errors when try to register (empty array => no error)

Create the array to render the registration form Takes eventual changes through plugins into account

getRegisterForm(Integer $iSurveyId): array

Arguments

$iSurveyId

Integer

The surey id

Response

array

The rendereable array

Creates the array for the registration success page

getRegisterSuccess(Integer $iSurveyId,Integer $iTokenId): array

Arguments

$iSurveyId

Integer

The survey id

$iTokenId

Integer

The token id

Response

array

The rendereable array

Get the date if survey is future

getStartDate(integer $iSurveyId): null|string

Arguments

$iSurveyId

integer

Response

null|string

date

Get the token id according to filled values

getTokenId( $iSurveyId): integer

Arguments

$iSurveyId

Response

integer

: the token id created

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

Send the register email with $_POST value

sendRegistrationEmail( $iSurveyId, $iTokenId): boolean

Arguments

$iSurveyId

Survey Id to register

$iTokenId

Response

boolean

: if email is set to sent (before SMTP problem)

Properties

layout

layout :

Type(s)

sTemplate

sTemplate :

Type(s)

aReplacementData

aReplacementData :

Type(s)

aGlobalData

aGlobalData :

Type(s)

The array of errors to be displayed

aRegisterErrors :

Type(s)

The message to be shown, is not null: default form not shown

sMessage :

Type(s)

The message to diplay after sending the register email

sMailMessage :

Type(s)

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

navData :array
inherited
var

Type(s)

array