LimeSurvey API - Master branch
Back to top  

UserAction

Extends \Survey_Common_Action

User Controller

This controller performs user 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

Arguments

$aData

array

_filterImportedResources

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

Arguments

$extractdir

string

$destdir

string

Response

array

_fullpagebar

_fullpagebar( $aData)
inherited

Arguments

$aData

Get Post- or Paramvalue depending on where to get it

_getPostOrParam(string $param) : string

Arguments

$param

string

Response

string

_getSurveyCountForUser

_getSurveyCountForUser(array $user)

Arguments

$user

array

_getUserNameFromUid

_getUserNameFromUid( $uid)

Arguments

$uid

listquestion groups

_listquestiongroups(array $aData)
inherited

Arguments

$aData

array

_listquestions

_listquestions( $aData)
inherited

Arguments

$aData

_messageBoxWithRedirect

_messageBoxWithRedirect( $title,  $message, string $classMsg,  $extra = "",  $url = "",  $urlText = "",  $hiddenVars = array(),  $classMbTitle = "header ui-widget-header")

Arguments

$title

$message

$classMsg

string

$extra

$url

$urlText

$hiddenVars

$classMbTitle

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

_refreshtemplates

_refreshtemplates()

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

Add a new survey administrator user

adduser() : void

Returns content from event beforeSideMenuRender

beforeSideMenuRender(array $aData) : string
inherited

Arguments

$aData

array

Response

string

deleteFinalUser

deleteFinalUser(array<mixed,\CActiveRecord> $result,  $transfer_surveys_to) : void
todo

Delete what final user?

Arguments

$result

array<mixed,\CActiveRecord>

TODO: Used at all?

$transfer_surveys_to

TODO: ?

Delete user

deluser()

escape

escape( $str)

Arguments

$str

escape_str

escape_str(string $str,  $like = false)

Arguments

$str

string

$like

Get extra menus from plugins that are using event beforeAdminMenuRender

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

Arguments

$aData

array

Response

\array

index

index() : void
inherited

Show users table

index()

Modify User

modifyuser()

Modify User POST

moduser()

Manage user personal settings

personalsettings()

remove_invisible_characters

remove_invisible_characters(string $str,  $url_encoded = true)

Arguments

$str

string

$url_encoded

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

savepermissions

savepermissions()

setuserpermissions

setuserpermissions()

setusertemplates

setusertemplates()

usertemplates

usertemplates()