LimeSurvey API - Master branch
Back to top  

LimeReplacementFieldsController

Extends\LSBaseController

Class LSBaseController

this controller will have all the necessary methods from the old AdminController

package

Default

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

actionIndex

actionIndex(): false|string|array<mixed,string>|null
todo

: document me ...
Throws
\CException
\CHttpException

Response

false|string|array<mixed,string>|null

addQuestionToList

addQuestionToList( $action,integer $gid,array $field, $questionType,string $surveyformat, $isPreviousPageQuestion, &$questionList)
todo

: document me

Arguments

$action

$gid

integer

$field

array

$questionType

$surveyformat

string

$isPreviousPageQuestion

$questionList

This part comes from renderWrappedTemplate (not the best way to refactoring, but a temporary solution)

beforeRender(string $view): boolean
inherited

todo REFACTORING find all actions that set $aData['surveyid'] and change the layout directly in the action

Arguments

$view

string

Response

boolean

collectQuestionReplacements

collectQuestionReplacements( $surveyid,null $gid = null,null $qid = null): array
todo

: document me

Arguments

$surveyid

$gid

null

$qid

null

Response

array

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

getChildQuestions

getChildQuestions(array $questions): array
todo

: document me

Arguments

$questions

array

Response

array

getNewTypeResponse

getNewTypeResponse( $fieldtype,null $surveyid = null,null $gid = null,null $qid = null): array
todo

document me ..

Arguments

$fieldtype

$surveyid

null

$gid

null

$qid

null

Response

array

getQuestionList

getQuestionList( $action,integer $gid,integer $qid,array $fieldmap, $questionType,string $surveyformat): array

Arguments

$action

$gid

integer

$qid

integer

$fieldmap

array

$questionType

$surveyformat

string

Response

array

Collect the general replacements

getReplacementFields(string $fieldtype,integer $surveyid): array

Arguments

$fieldtype

string

The field to collect replacements for

$surveyid

integer

The transferred surveyid

Response

array

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

Method to render an array as a json document (this one called by a lot of actions in different controllers)

renderJSON(array $aData, $success = true): void
inherited

Arguments

$aData

array

$success

Checks for action specific authorization and then executes an action

run(string $action): void
inherited

TODO: check the dbupdate mechanism, do we really want to check db update before every action??

access

public
Throws
\CException
\CHttpException

Arguments

$action

string

Load and set session vars

sessionControl(): void
inherited

todo REFACTORING see comments in mehtod

access

protected

shouldAddQuestion

shouldAddQuestion( $action,integer $gid,integer $qid,array $question, $previousQuestion)
todo

: document me ..

Arguments

$action

$gid

integer

$qid

integer

$question

array

$previousQuestion

Properties

this is needed for the preview rendering inside the questioneditor

sTemplate :null
inherited
var

this is needed for the preview rendering inside the questioneditor

Type(s)

null

import for all new controllers/actions (REFACTORING) to pass data before rendering the content

aData :array
inherited
var

import for all new controllers/actions (REFACTORING) to pass data before rendering the content

Type(s)

array

userId of the logged in user

userId :integer
inherited
var

userId of the logged in user

Type(s)

integer

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

navData :array
inherited
var

Type(s)

array