responses

Extends \Survey_Common_Action

Responses Controller

This controller performs browse actions.

package

LimeSurvey

subpackage

Backend

Methods

__construct

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

Arguments

$controller

$id

Used to get responses data for browse etc

_getData(mixed $params) : array
todo

Don't use extract

Arguments

$params

mixed

?

Response

array

getActionParams

getActionParams() 

viewbytoken

viewbytoken($iSurveyID, $token, $sBrowseLang = '') 

Arguments

$iSurveyID

$token

$sBrowseLang

View a single response as queXML PDF

viewquexmlpdf(mixed $iSurveyID, mixed $iId, mixed $sBrowseLang = '') 

Arguments

$iSurveyID

mixed

$iId

mixed

$sBrowseLang

mixed

View a single response in detail

view(mixed $iSurveyID, mixed $iId, mixed $sBrowseLang = '') 

Arguments

$iSurveyID

mixed

$iId

mixed

$sBrowseLang

mixed

index

index($iSurveyID) 

Arguments

$iSurveyID

Change the value of the max characters to elipsize headers/questions in reponse grid.

set_grid_display() 

It's called via ajax request

Show responses for survey

browse(int $iSurveyId) : void

Arguments

$iSurveyId

int

Saves the hidden columns for response browsing in the session

setHiddenColumns($iSurveyId) 
access

public

Arguments

$iSurveyId

Do an actions on response

actionResponses(mixed $iSurveyId) : void
access

public

Arguments

$iSurveyId

mixed

: survey id

Delete response

actionDelete($surveyid) : void
access

public

Arguments

$surveyid

Download individual file by response and filename

actionDownloadfile(mixed $iSurveyId, mixed $iResponseId, mixed $iQID, $iIndex) : \application/octet-stream
access

public

Arguments

$iSurveyId

mixed

: survey id

$iResponseId

mixed

: response if

$iQID

mixed

: The question ID

$iIndex

Response

\application/octet-stream

Construct a zip files from a list of response

actionDownloadfiles(mixed $iSurveyId, mixed $sResponseId) : \application/zip
access

public

Arguments

$iSurveyId

mixed

: survey id

$sResponseId

mixed

: list of response

Response

\application/zip

Delete all uploaded files for one response.

actionDeleteAttachments() : void

Time statistics for responses

time(int $iSurveyID) : void

Arguments

$iSurveyID

int

Supply an array with the responseIds and all files will be added to the zip and it will be be spit out on success

_zipFiles(int $iSurveyID, array $responseIds, string $zipfilename) : \ZipArchive

Arguments

$iSurveyID

int

$responseIds

array

$zipfilename

string

Response

\ZipArchive

Responsible for setting the session variables for attribute map page redirect

setSession($unset = false, $sid = null) 
todo

Use user session?

Used?

Arguments

$unset

$sid

Renders template(s) wrapped in header and footer

_renderWrappedTemplate(string $sAction = '', string|array $aViewUrls = array(), array $aData = array()) 
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

string|array

View url(s)

$aData

array

Data to be passed on. Optional.

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

runWithParams(array $params) 
inherited

Arguments

$params

array

URL Parameters

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 {@link Survey_Common_Action::_renderWrappedTemplate()}

Arguments

$params

array

Parameters to parse and populate

Response

array

Populated parameters

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

run() 
inherited

Routes the action into correct subaction

route(string $sa, string[] $get_vars) : void
inherited
access

protected

Arguments

$sa

string

$get_vars

string[]

Display the update notification

_updatenotification() 
inherited

Display notifications

_notifications() 
inherited

Survey summary

_nsurveysummary($aData) 
inherited

Arguments

$aData

Header

_showHeaders($aData) 
inherited

Arguments

$aData

_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

$adminmenu

_titlebar

_titlebar($aData) 
inherited

Arguments

$aData

_tokenbar

_tokenbar($aData) 
inherited

Arguments

$aData

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($aData) 
inherited

Arguments

$aData

Show admin menu for question group view

_nquestiongroupbar(array $aData) 
inherited

Arguments

$aData

array

?

_fullpagebar

_fullpagebar($aData) 
inherited

Arguments

$aData

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

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

listquestion groups

_listquestiongroups($aData) 
inherited

Arguments

$aData

_listquestions

_listquestions($aData) 
inherited

Arguments

$aData

Show survey summary

_surveysummary($aData) 
inherited

Arguments

$aData

Browse Menu Bar

_browsemenubar($aData) 
inherited

Arguments

$aData

Load menu bar of user group controller.

_userGroupBar($aData) : void
inherited

Arguments

$aData

This function will register a script file, and will choose if it should use the asset manager or not

registerScriptFile(string $cPATH, string $sFile) 
inherited

Arguments

$cPATH

string

: the CONSTANT name of the path of the script file (need to be converted in url if asset manager is not used)

$sFile

string

: the file to publish

This function will register a script file, and will choose if it should use the asset manager or not

registerCssFile(string $sPath, string $sFile) 
inherited

Arguments

$sPath

string

: the type the path of the css file to publish ( public, template, etc)

$sFile

string

: the file to publish

_filterImportedResources

_filterImportedResources(string $extractdir, string $destdir) 
inherited

Arguments

$extractdir

string

$destdir

string

Creates a temporary directory

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

protected

Arguments

$dir

string

$prefix

string

$mode

int

Response

string

Get extra menus from plugins that are using event beforeAdminMenuRender

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

Arguments

$aData

array

Response

\array

Properties

: Default layout is bare : temporary to real layout

layout : string
var

: Default layout is bare : temporary to real layout

Type(s)

string