Survey_Common_Action

Extends\CAction

Survey Common Action

This controller contains common functions for survey related views.

package

LimeSurvey

subpackage

Backend

author

LimeSurvey Team

Methods

__construct

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

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

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)

DEPRECATED ??? Never used...

Arguments

$aData

array

_filterImportedResources

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

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

Arguments

$extractdir

string

$destdir

string

Response

array

_fullpagebar

_fullpagebar( $aData)

Arguments

$aData

REFACTORED in LayoutHelper

_generaltopbar( $aData)
Throws
\CException

Arguments

$aData

REFACTORED in LayoutHelper

_generaltopbarAdditions( $aData)
Throws
\CException

Arguments

$aData

REFACTORED in LayoutHelper

_listquestiongroups(array $aData)

listquestion groups

Arguments

$aData

array

REFACTORED in LayoutHelper

_listquestions( $aData)
Throws
\CException

Arguments

$aData

Display notifications

_notifications()
  • REFACTORED (in LayoutHelper.php)

Show admin menu for question group view

_nquestiongroupbar(array $aData)

Arguments

$aData

array

?

REFACTORED in LayoutHelper

_nsurveysummary(array $aData)

Survey summary

Arguments

$aData

array

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

_organizequestionbar(array $aData)

REFACTORED in LayoutHelper

since 2014-09-30
author

Olle Haerstedt

Arguments

$aData

array

Shows admin menu for question

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

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

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

Arguments

$aData

array

$sendHTTPHeader

Shows admin menu for surveys

_surveybar(array $aData)
deprecated

Arguments

$aData

array

Show side menu for survey view

_surveysidemenu(array $aData)

REFACTORED in LayoutHelper.php

Arguments

$aData

array

all the needed data

REFACTORED in LayoutHelper

_surveysummary(array $aData)

Show survey summary

Arguments

$aData

array

REFACTORED in LayoutHelper.php

_titlebar( $aData)
Throws
\CException

Arguments

$aData

Display the update notification

_updatenotification()

REFACTORED (in LayoutHelper.php)

Load menu bar of user group controller.

_userGroupBar(array $aData): void

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

Arguments

$aData

array

Returns content from event beforeSideMenuRender

beforeSideMenuRender(array $aData): string

REFACTORED in LayoutHelper

Arguments

$aData

array

Response

string

Get extra menus from plugins that are using event beforeAdminMenuRender

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

Arguments

$aData

array

Response

\array

index

index(): void

Rendering the subviews and views of _renderWrappedTemplate

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

Arguments

$sAction

string

$aViewUrls

array|string

$aData

array

Response

string

renderInternal

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

Arguments

$_viewFile_

string

$_data_

$_return_

Method to render an array as a json document

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

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

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
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()

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

runWithParams(array $params): boolean

Arguments

$params

array

URL Parameters

Response

boolean