LimeSurvey API - Master branch

LimeReplacementFieldsController extends LSBaseController
in package

Class LSBaseController

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

Table of Contents

Properties

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

Methods

__construct()  : mixed
Basic initialiser to the base controller class
actionIndex()  : false|string|array<string|int, string>|null
createAbsoluteUrl()  : string
Returns an absolute URL based on the given controller and action information.
getNewTypeResponse()  : array<string|int, mixed>
loadHelper()  : void
Loads a helper
loadLibrary()  : void
Loads a library
run()  : void
Checks for action specific authorization and then executes an action
_checkInstallation()  : void
Check that installation was already done by looking for config.php Will redirect to the installer script if not exists.
beforeRender()  : bool
This part comes from renderWrappedTemplate (not the best way to refactoring, but a temporary solution)
customInit()  : mixed
loadPageStates()  : array<string|int, mixed>
Loads page states from a hidden input.
renderJSON()  : void
Method to render an array as a json document (this one called by a lot of actions in different controllers)
sessionControl()  : void
Load and set session vars
addQuestionToList()  : mixed
collectQuestionReplacements()  : array<string|int, mixed>
getChildQuestions()  : array<string|int, mixed>
getQuestionList()  : array<string|int, mixed>
getReplacementFields()  : array<string|int, mixed>
Collect the general replacements
shouldAddQuestion()  : mixed

Properties

$aData

public array<string|int, mixed> $aData = []

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

$navData

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

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

$sTemplate

public null $sTemplate = \null

this is needed for the preview rendering inside the questioneditor

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

actionIndex()

public actionIndex() : false|string|array<string|int, string>|null
Tags
todo:

document me ...

throws
CException
throws
CHttpException
Return values
false|string|array<string|int, string>|null

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

getNewTypeResponse()

public getNewTypeResponse( $fieldtype[, null $surveyid = null ][, null $gid = null ][, null $qid = null ]) : array<string|int, mixed>
Parameters
$fieldtype :
$surveyid : null = null
$gid : null = null
$qid : null = null
Tags
todo

document me ..

Return values
array<string|int, mixed>

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

run()

Checks for action specific authorization and then executes an action

public run(string $action) : void

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

Parameters
$action : string
Tags
access

public

throws
CException
throws
CHttpException

_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

beforeRender()

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

protected beforeRender(string $view) : bool

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

Parameters
$view : string
Return values
bool

loadPageStates()

Loads page states from a hidden input.

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

the loaded page states

renderJSON()

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

protected renderJSON(array<string|int, mixed> $aData[, mixed $success = true ]) : void
Parameters
$aData : array<string|int, mixed>
$success : mixed = true

sessionControl()

Load and set session vars

protected sessionControl() : void

todo REFACTORING see comments in mehtod

Tags
access

protected

addQuestionToList()

private addQuestionToList(mixed $action, int $gid, array<string|int, mixed> $field, mixed $questionType, string $surveyformat, mixed $isPreviousPageQuestion, mixed &$questionList) : mixed
Parameters
$action : mixed
$gid : int
$field : array<string|int, mixed>
$questionType : mixed
$surveyformat : string
$isPreviousPageQuestion : mixed
$questionList : mixed
Tags
todo:

document me

collectQuestionReplacements()

private collectQuestionReplacements( $surveyid[, null $gid = null ][, null $qid = null ]) : array<string|int, mixed>
Parameters
$surveyid :
$gid : null = null
$qid : null = null
Tags
todo:

document me

Return values
array<string|int, mixed>

getChildQuestions()

private getChildQuestions(array<string|int, mixed> $questions) : array<string|int, mixed>
Parameters
$questions : array<string|int, mixed>
Tags
todo:

document me

Return values
array<string|int, mixed>

getQuestionList()

private getQuestionList(mixed $action, int $gid, int $qid, array<string|int, mixed> $fieldmap, mixed $questionType, string $surveyformat) : array<string|int, mixed>
Parameters
$action : mixed
$gid : int
$qid : int
$fieldmap : array<string|int, mixed>
$questionType : mixed
$surveyformat : string
Return values
array<string|int, mixed>

getReplacementFields()

Collect the general replacements

private getReplacementFields(string $fieldtype, int $surveyid) : array<string|int, mixed>
Parameters
$fieldtype : string

The field to collect replacements for

$surveyid : int

The transferred surveyid

Return values
array<string|int, mixed>

shouldAddQuestion()

private shouldAddQuestion(mixed $action, int $gid, int $qid, array<string|int, mixed> $question, mixed $previousQuestion) : mixed
Parameters
$action : mixed
$gid : int
$qid : int
$question : array<string|int, mixed>
$previousQuestion : mixed
Tags
todo:

document me ..


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results