questions

Extends \Survey_Common_Action

question

This controller contains common functions for survey related views.

package

LimeSurvey

author
copyright

2011

access

public

Methods

__construct

__construct( $controller = null,  $id = null) 
inherited

Arguments

$controller

$id

Some functions have different parameters, which are just an alias of the usual parameters we're getting in the url. This function just populates those variables so that we don't end up in an error.

_addPseudoParams(array $params) : array
inherited

This is also used while rendering wrapped template Survey_Common_Action::_renderWrappedTemplate()

Throws
\CHttpException

Arguments

$params

array

Parameters to parse and populate

Response

array

Populated parameters

Browse Menu Bar

_browsemenubar(array $aData) 
inherited

Arguments

$aData

array

Load editing of answer options specific screen only.

_editansweroptions(integer $surveyid, integer $gid, integer $qid) : array
access

public

Arguments

$surveyid

integer

$gid

integer

$qid

integer

Response

array

Load only subquestion specific screen only.

_editsubquestion(integer $surveyid, integer $gid, integer $qid) : array
access

public

Arguments

$surveyid

integer

$gid

integer

$qid

integer

Response

array

_filterImportedResources

_filterImportedResources(string $extractdir, string $destdir) : array
inherited

Arguments

$extractdir

string

$destdir

string

Response

array

_fullpagebar

_fullpagebar( $aData) 
inherited

Arguments

$aData

listquestion groups

_listquestiongroups(array $aData) 
inherited

Arguments

$aData

array

_listquestions

_listquestions( $aData) 
inherited

Arguments

$aData

Display notifications

_notifications() 
inherited

Show admin menu for question group view

_nquestiongroupbar(array $aData) 
inherited

Arguments

$aData

array

?

Survey summary

_nsurveysummary(array $aData) 
inherited

Arguments

$aData

array

Render the save/cancel bar for Organize question groups/questions

_organizequestionbar(array $aData) 
inherited
since 2014-09-30
author

Olle Haerstedt

Arguments

$aData

array

Shows admin menu for question

_questionbar(array $aData) 
inherited

Arguments

$aData

array

Renders template(s) wrapped in header and footer

_renderWrappedTemplate(string $sAction = '', array|string $aViewUrls = array(), array $aData = array(), string|boolean $sRenderFile = false) 
inherited

Addition of parameters should be avoided if they can be added to $aData

NOTE FROM LOUIS : We want to remove this function, wich doesn't respect MVC pattern. The work it's doing should be handle by layout files, and subviews inside views. Eg : for route "admin/survey/sa/listquestiongroups/surveyid/282267" the Group controller should use a main layout (with admin menu bar as a widget), then render the list view, in wich the question group bar is called as a subview.

So for now, we try to evacuate all the renderWrappedTemplate logic (if statements, etc.) to subfunctions, then it will be easier to remove. Comments starting with //// indicate how it should work in the future

Arguments

$sAction

string

Current action, the folder to fetch views from

$aViewUrls

array|string

View url(s)

$aData

array

Data to be passed on. Optional.

$sRenderFile

string|boolean

File to be rendered as a layout. Optional.

_showadminmenu() function returns html text for the administration button bar

_showadminmenu( $aData) : string
inherited
access

public

global

string $homedir

string $scriptname

string $surveyid

string $setfont

string $imageurl

int $surveyid

Arguments

$aData

Response

string

Header

_showHeaders(array $aData,  $sendHTTPHeader = true) 
inherited

Arguments

$aData

array

$sendHTTPHeader

Shows admin menu for surveys

_surveybar( $aData) 
inherited

Arguments

$aData

Show side menu for survey view

_surveysidemenu(array $aData) 
inherited

Arguments

$aData

array

all the needed data

Show survey summary

_surveysummary(array $aData) 
inherited

Arguments

$aData

array

Creates a temporary directory

_tempdir(string $dir, string $prefix = '', integer $mode = 448) : string
inherited
access

protected

Arguments

$dir

string

$prefix

string

$mode

integer

Response

string

_titlebar

_titlebar( $aData) 
inherited

Arguments

$aData

_tokenbar

_tokenbar( $aData) 
inherited

Arguments

$aData

Display the update notification

_updatenotification() 
inherited

Load menu bar of user group controller.

_userGroupBar(array $aData) : void
inherited

Arguments

$aData

array

Show error and redirect back if survey is active

abortIfSurveyIsActive(\Survey $survey) : void

Arguments

$survey

\Survey

ajaxchecklabel

ajaxchecklabel() 

This function prepares the data for label set details

ajaxlabelsetdetails( $lid) : void
access

public

Arguments

$lid

This function prepares the data for labelset

ajaxlabelsetpicker( $sid,  $match) : void
access

public

Arguments

$sid

$match

This function prepares the data for the advanced question attributes view

ajaxquestionattributes() : void
access

public

ajaxReloadPositionWidget

ajaxReloadPositionWidget( $gid,  $classes = '') 

Arguments

$gid

$classes

function ajaxValidate

ajaxValidate( $surveyid,  $qid = false) 

Arguments

$surveyid

$qid

Load complete editing of answer options screen.

answeroptions(integer $surveyid, integer $gid, integer $qid) 
access

public

Arguments

$surveyid

integer

$gid

integer

$qid

integer

Returns content from event beforeSideMenuRender

beforeSideMenuRender(array $aData) : string
inherited

Arguments

$aData

array

Response

string

Function responsible for deleting a question.

delete(integer $surveyid, integer $qid,  $ajax = false) : array
access

public

Arguments

$surveyid

integer

$qid

integer

$ajax

Response

array

Delete multiple questions.

deleteMultiple() : \HTML

Called by ajax from question list. Permission check is done by questions::delete()

Response

\HTML

Load edit default values of a question screen

editdefaultvalues(integer $surveyid, integer $gid, integer $qid) : void
access

public

Arguments

$surveyid

integer

$gid

integer

$qid

integer

Get extra menus from plugins that are using event beforeAdminMenuRender

fetchExtraMenus(array $aData) : \array<ExtraMenu>
inherited

Arguments

$aData

array

Response

\array

This function should be called via ajax request It returns a EMPTY subquestion row HTML for a given .

getSubquestionRow( $surveyid,  $gid, string $qid,  $codes,  $language,  $first,  $scale_id,  $type,  $position,  $assessmentvisible = '') 

...

Arguments

$surveyid

$gid

$qid

string

$codes

$language

$first

$scale_id

$type

$position

$assessmentvisible

getSubquestionRowForAllLanguages

getSubquestionRowForAllLanguages( $surveyid,  $gid,  $codes,  $scale_id,  $type,  $languages,  $position,  $assessmentvisible = '') 

Arguments

$surveyid

$gid

$codes

$scale_id

$type

$languages

$position

$assessmentvisible

AJAX Method to QuickAdd multiple Rows AJAX-based

getSubquestionRowQuickAdd( $surveyid,  $gid) 
todo

Permission

Arguments

$surveyid

$gid

Function responsible to import a question.

import() : void
access

public

Display import view

importView( $groupid = null,  $surveyid) 

Arguments

$groupid

$surveyid

index

index() : void
inherited

Load edit/new question screen depending on $action.

index(string $sa, integer $surveyid, integer $gid, integer $qid = null) : void
access

public

Arguments

$sa

string

subaction

$surveyid

integer

$gid

integer

$qid

integer

Add a new question

newquestion( $surveyid) : string

Arguments

$surveyid

int the sid

Response

string

html

Rendering the subviews and views of _renderWrappedTemplate

renderCentralContents(string $sAction, array|string $aViewUrls, array $aData = array()) : string
inherited

Arguments

$sAction

string

$aViewUrls

array|string

$aData

array

Response

string

renderInternal

renderInternal(string $_viewFile_,  $_data_ = null,  $_return_ = false) 
inherited
inheritdoc

Arguments

$_viewFile_

string

$_data_

$_return_

Render the quick-menu that is shown when side-menu is hidden.

renderQuickmenu(array $aData) : string
inherited

Only show home-icon for now.

Add support for plugin to attach icon elements using event afterQuickMenuLoad

todo

Make quick-menu user configurable

Arguments

$aData

array

Response

string

Routes the action into correct subaction

route(string $sa, array<mixed,string> $get_vars) : mixed
inherited
access

protected

Arguments

$sa

string

$get_vars

array<mixed,string>

Response

mixed

Action classes require them to have a run method. We reroute it to index if called.

run() 
inherited

Override runWithParams() implementation in CAction to help us parse requests with subactions.

runWithParams(array $params) : boolean
inherited

Arguments

$params

array

URL Parameters

Response

boolean

Set attributes for multiple questions

setMultipleAttributes() 

setMultipleMandatory

setMultipleMandatory() 

setMultipleOther

setMultipleOther() 

Change the question group/order position of multiple questions

setMultipleQuestionGroup() 

Load complete subquestions screen.

subquestions(integer $surveyid, integer $gid, integer $qid) : void
access

public

Arguments

$surveyid

integer

$gid

integer

$qid

integer

view

view( $surveyid,  $gid,  $qid) 

Arguments

$surveyid

$gid

$qid