GlobalSettings Controller
This controller contains common functions for survey related views.
| package | Default |
|---|
__construct( $controller = null, $id = null)
addPseudoParams(array $params): array
This is also used while rendering wrapped template SurveyCommonAction::renderWrappedTemplate()
| Throws |
|
|---|
arrayParameters to parse and populate
arrayPopulated parameters
beforeSideMenuRender(array $aData): string
REFACTORED in LayoutHelper
array
string checkSettings()
displaySettings()
| Throws |
|
|---|
fetchExtraMenus(array $aData): \array<ExtraMenu>
array
\array filterImportedResources(string $extractdir,string $destdir): array
| deprecated | use ServiceClass FilterImportedResources instead ... (models/services/) |
|---|
string
string
array getStorageData(): void
getSurveyFolderStorage(string $uploaddir,integer $decimals): array
string
integer
array getTemplateFolderStorage(string $uploaddir,integer $decimals): array
string
integer
array HelloWorld(string $sWho = "World"): array
You can reach it via: index.php?r=admin/globalsettings/sa/HelloWorld/
stringwho to say hello
arrayPopulated parameters ready to be rendered inside the admin interface
index(): void
index(): void
| access | public |
|---|---|
| Throws |
|
listquestiongroups(array $aData)
listquestion groups
array
listquestions( $aData)
| Throws |
|
|---|
notifications()
nsurveysummary(array $aData)
Survey summary
array
refreshAssets()
renderCentralContents(string $sAction,array|string $aViewUrls,array $aData = array()): string
string
array|string
array
string renderInternal(string $_viewFile_, $_data_ = null, $_return_ = false)
| inheritdoc | |
|---|---|
string
renderJSON(array $aData, $success = true): void
REFACTORED in LSBaseController (this one called by a lot of actions in different controllers)
array
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, which 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 which 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 |
|
|---|
stringCurrent action, the folder to fetch views from
array|stringView url(s)
arrayData to be passed on. Optional.
string|booleanFile to be rendered as a layout. Optional.
requirePostRequest()
This is intended to be used on subactions. When possible (eg. when refactoring a SurveyCommonAction into an actual controller), use 'postOnly' filter instead.
| Throws |
|
|---|
resetFailedLoginParticipants(): void
route(string $sa,array<mixed,string> $get_vars): mixed
| access | protected |
|---|
string
array<mixed,string>
mixed run()
runWithParams(array $params): boolean
arrayURL Parameters
boolean saveSettings()
sendEmailAndShowResult(string $body,string $sSubject,string $sTo,string $sFrom)
string
string
string
string
sendTestEmail()
sendTestEmailConfirmation()
showHeaders(array $aData, $sendHTTPHeader = true)
array
showphpinfo()
surveyManagerBar(array $aData)
| todo | Needs to be removed later. Duplication in LayoutHelper. |
|---|---|
array
surveySettings()
updatenotification()
REFACTORED (in LayoutHelper.php)
userGroupBar(array $aData): void
REFACTORED (it's in UserGroupController and uses function from Layouthelper->renderMenuBar())
array
validateIpAddresses(string $ipList): \array<string,string>
stringlist of IP addresses to validate, separated by comma or new line
\arrayan array of the form ['valid' => validlist, 'invalid' => invalidlist] where each list is a comma separated string.
myNewParam :