LimeSurvey API - Master branch
Back to top  

OptinController

Extends\LSYii_Controller

optin

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

Add token back to the survey (remove 'OptOut' status) and/or add participant back to the CPDB (remove from blacklist).

actionaddtokens()

The participant is only removed from the blacklist if the 'global' URL param is true and 'allowunblacklist' is enabled.

Display the confirmation for global opt in

actionparticipants()

Display the confirmation for individual survey opt in

actiontokens()

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

Render stuff

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

Arguments

$message

string

$survey

\Survey

$link

string

$token

\array

$participant

\array

Properties

layout

layout :

Type(s)

defaultAction

defaultAction :

Type(s)

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

navData :array
inherited
var

Type(s)

array