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

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

DEPRECATED ??? Never used...

Arguments

$aData

array

_filterImportedResources

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

use ServiceClass FilterImportedResources instead ... (models/services/)

Arguments

$extractdir

string

$destdir

string

Response

array

_fullpagebar

_fullpagebar( $aData)
inherited

Arguments

$aData

REFACTORED in LayoutHelper

_generaltopbar( $aData)
inherited
Throws
\CException

Arguments

$aData

REFACTORED in LayoutHelper

_generaltopbarAdditions( $aData)
inherited
Throws
\CException

Arguments

$aData

Used to get responses data for browse etc

_getData(mixed $params): array
todo

Don't use extract

Arguments

$params

mixed

?

Response

array

REFACTORED in LayoutHelper

_listquestiongroups(array $aData)
inherited

listquestion groups

Arguments

$aData

array

REFACTORED in LayoutHelper

_listquestions( $aData)
inherited
Throws
\CException

Arguments

$aData

Display notifications

_notifications()
inherited
  • REFACTORED (in LayoutHelper.php)

Show admin menu for question group view

_nquestiongroupbar(array $aData)
inherited

Arguments

$aData

array

?

REFACTORED in LayoutHelper

_nsurveysummary(array $aData)
inherited

Survey summary

Arguments

$aData

array

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

_organizequestionbar(array $aData)
inherited

REFACTORED in LayoutHelper

since 2014-09-30
author

Olle Haerstedt

Arguments

$aData

array

Shows admin menu for question

_questionbar(array $aData)
inherited
deprecated

not in use anymore

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

Throws
\CHttpException

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

REFACTORED (in LayoutHelper.php)

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
  • REFACTORED (in LayoutHelper.php)

Arguments

$aData

array

$sendHTTPHeader

Shows admin menu for surveys

_surveybar(array $aData)
inherited
deprecated

Arguments

$aData

array

Show side menu for survey view

_surveysidemenu(array $aData)
inherited

REFACTORED in LayoutHelper.php

Arguments

$aData

array

all the needed data

REFACTORED in LayoutHelper

_surveysummary(array $aData)
inherited

Show survey summary

Arguments

$aData

array

REFACTORED in LayoutHelper.php

_titlebar( $aData)
inherited
Throws
\CException

Arguments

$aData

Display the update notification

_updatenotification()
inherited

REFACTORED (in LayoutHelper.php)

Load menu bar of user group controller.

_userGroupBar(array $aData): void
inherited

REFACTORED (it's in UserGroupController and uses function from Layouthelper->renderMenuBar())

Arguments

$aData

array

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(integer $iSurveyID,array $responseIds,string $zipfilename): \ZipArchive
todo

missing return statement (php warning)

Arguments

$iSurveyID

integer

$responseIds

array

$zipfilename

string

Response

\ZipArchive

Delete response

actionDelete( $surveyid): void
access

public

Throws
\CDbException
\CException
\CHttpException

Arguments

$surveyid

Delete all uploaded files for one response.

actionDeleteAttachments(): void
Throws
\CException
\CHttpException

Download individual file by response and filename

actionDownloadfile( $iSurveyId, $iResponseId, $iQID, $iIndex): void
access

public

Arguments

$iSurveyId

: survey id

$iResponseId

: response if

$iQID

: The question ID

$iIndex

Construct a zip files from a list of response

actionDownloadfiles( $iSurveyId, $sResponseId): void
access

public

Throws
\CException

Arguments

$iSurveyId

: survey id

$sResponseId

: list of response

Do an actions on response

actionResponses( $iSurveyId): void
access

public

Throws
\CDbException
\CException
\CHttpException

Arguments

$iSurveyId

: survey id

Returns content from event beforeSideMenuRender

beforeSideMenuRender(array $aData): string
inherited

REFACTORED in LayoutHelper

Arguments

$aData

array

Response

string

Show responses for survey

browse(integer $iSurveyId): void
Throws
\CHttpException

Arguments

$iSurveyId

integer

Get extra menus from plugins that are using event beforeAdminMenuRender

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

Arguments

$aData

array

Response

\array

getActionParams

getActionParams(): array

Response

array

index

index(): void
inherited

index

index( $iSurveyID)
todo

document me

Throws
\CHttpException

Arguments

$iSurveyID

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_

Method to render an array as a json document

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

REFACTORED in LSBaseController (this one called by a lot of actions in different controllers)

Arguments

$aData

array

$success

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

renderQuickmenu(array $aData): string
inherited

REFACTORED in LayoutHelper

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

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

set_grid_display( $displaymode): void

It's called via ajax request

Arguments

$displaymode

Saves the hidden columns for response browsing in the session

setFilteredColumns( $surveyid): string
access

public

Arguments

$surveyid

Response

string

Responsible for setting the session variables for attribute map page redirect

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

Use user session?

Used?

Arguments

$unset

$sid

Time statistics for responses

time(integer $iSurveyID): void
Throws
\CHttpException

Arguments

$iSurveyID

integer

View a single response in detail

view(mixed $iSurveyID,mixed $iId,mixed $sBrowseLang = '')
Throws
\CException
\CHttpException

Arguments

$iSurveyID

mixed

$iId

mixed

$sBrowseLang

mixed

viewbytoken

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

Arguments

$iSurveyID

$token

$sBrowseLang

string

View a single response as queXML PDF

viewquexmlpdf(mixed $iSurveyID,mixed $iId,mixed $sBrowseLang = '')
Throws
\CException
\CHttpException

Arguments

$iSurveyID

mixed

$iId

mixed

$sBrowseLang

mixed

Properties

: Default layout is bare : temporary to real layout

layout :string
var

: Default layout is bare : temporary to real layout

Type(s)

string