LimeSurvey API - Master branch

OptoutController extends LSYii_Controller
in package

optout

Tags
copyright

2011

access

public

Table of Contents

Properties

$defaultAction  : mixed
$layout  : mixed
$navData  : array<string|int, mixed>
This array contains the survey / group / question id used by the menu widget.

Methods

__construct()  : mixed
Basic initialiser to the base controller class
actionparticipants()  : mixed
Display the confirmation for global opt out
actionremovetokens()  : mixed
This function is run when opting out of an individual survey participants table. The other function /optout/participants opts the user out of ALL survey invitations from the system
actiontokens()  : mixed
Display the confirmation for individual survey opt out
createAbsoluteUrl()  : string
Returns an absolute URL based on the given controller and action information.
loadHelper()  : void
Loads a helper
loadLibrary()  : void
Loads a library
_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.
renderHtml()  : void
Render something

Properties

$navData

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

public array<string|int, mixed> $navData = array()

Methods

__construct()

Basic initialiser to the base controller class

public __construct(string $id[, CWebModule $module = null ]) : mixed
Parameters
$id : string
$module : CWebModule = null
Tags
access

public

actionparticipants()

Display the confirmation for global opt out

public actionparticipants() : mixed

actionremovetokens()

This function is run when opting out of an individual survey participants table. The other function /optout/participants opts the user out of ALL survey invitations from the system

public actionremovetokens() : mixed

actiontokens()

Display the confirmation for individual survey opt out

public actiontokens() : 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
access

public

loadLibrary()

Loads a library

public loadLibrary(string $library) : void
Parameters
$library : string
Tags
access

public

_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
access

protected

loadPageStates()

Loads page states from a hidden input.

protected loadPageStates() : array<string|int, mixed>
Return values
array<string|int, mixed>

the loaded page states

renderHtml()

Render something

private renderHtml(string $message, Survey $survey[, string $link = '' ][, array<string, mixed> $token = [] ][, array<string, mixed> $participant = [] ]) : void
Parameters
$message : string
$survey : Survey
$link : string = ''
$token : array<string, mixed> = []
$participant : array<string, mixed> = []

        
On this page

Search results