export

Extends \Survey_Common_Action

Export Action

This controller performs export actions

package

LimeSurvey

subpackage

Backend

Methods

__construct

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

Arguments

$controller

$id

survey

survey() 

This function exports a ZIP archives of several ZIP archives - it is used in the listSurvey controller The SIDs are read from session flashdata.

surveyarchives() 

group

group() 

question

question() 

exportresults

exportresults() 

exportspss

exportspss() 

vvexport

vvexport() 

resources

resources() 

dumplabel

dumplabel() 

Export multiple surveys structure. Called via ajax from surveys list massive action

exportMultipleStructureSurveys() 

Export multiple surveys structure. Called via ajax from surveys list massive action

exportMultiplePrintableSurveys() 

Export multiple surveys archives. Called via ajax from surveys list massive action

exportMultipleArchiveSurveys() 

exportMultipleSurveys

exportMultipleSurveys($sSurveys, string $sExportType) 

Arguments

$sSurveys

$sExportType

string

Download an archive file

downloadZip(string $sZip) 

Arguments

$sZip

string

name of zip file to download (will be downloaded as "surveys_archive.zip")

Exports a archive (ZIP) of the current survey (structure, responses, timings, tokens)

_exportarchive(integer $iSurveyID, boolean $bSendToBrowser = TRUE) : string

Arguments

$iSurveyID

integer

The ID of the survey to export

$bSendToBrowser

boolean

If TRUE (default) then the ZIP file is sent to the browser

Response

string

Full path of the ZIP filename if $bSendToBrowser is set to TRUE, otherwise no return value

_addToZip

_addToZip(\PclZip $zip, string $name, string $full_name) 

Arguments

$zip

\PclZip

$name

string

$full_name

string

_surveyexport

_surveyexport($action, $iSurveyID) 

Arguments

$action

$iSurveyID

Return a list of queXML settings

_quexmlsettings() : string[]
access

private

Response

string[]

queXML settings

Clear queXML settings from settings table

quexmlclear(int $iSurveyID) : void
access

public

Arguments

$iSurveyID

int

Generate a queXML PDF document with provided styles/settings

quexml(int $iSurveyID) : void
access

public

Arguments

$iSurveyID

int

Get a Zipped version of survey print version in all languages (including the template html assets)

_exportPrintableHtmls(integer $iSurveyID, bool $readFile = true) : string

Arguments

$iSurveyID

integer

Survey ID

$readFile

bool

Whether we read the file for direct download (or not as in massive actions)

Response

string

Get a the printable html questionnaire in specified language and store the file in the specified directory

_exportPrintableHtml(\Survey $oSurvey, string $language, string $tempdir) : string

Arguments

$oSurvey

\Survey

$language

string

$tempdir

string

the directory the file will be stored in

Response

string

File name where the data is stored

Generate an TSV (tab-separated value) file for the survey structure

_exporttsv(\type $surveyid) 

Arguments

$surveyid

\type

_addHeaders

_addHeaders($filename, string $content_type, $expires, $pragma = "public") 

Arguments

$filename

$content_type

string

$expires

$pragma

_xmlToJson

_xmlToJson($fileContents) 

Arguments

$fileContents

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