Generic controller class for showing and editing respondents
package | Gems |
---|---|
subpackage | Default |
copyright | Copyright (c) 2011 Erasmus MC |
license | New BSD License |
since | Class available since version 1.0 |
inherited_from | \Gems_Controller_ModelSnippetActionAbstract |
answerImportAction()
answerImportsAction()
autofilterAction($resetMvc = true
)
When true only the filtered resulsts
calculateDuration(mixed $value, boolean $isNew= false
, string $name= null
, array $context= array()
, boolean $isPost= false
) : \MUtil_Date | \Zend_Db_Expr | string
If empty or \Zend_Db_Expression (after save) it will return just the value currently there are no checks for a valid date format.
see |
---|
mixed
The value being saved
boolean
True when a new item is being saved
string
The name of the current field
array
Optional, the other values being saved
boolean
True when passing on post data
\MUtil_Date
\Zend_Db_Expr
string
calculateTrackCount(mixed $value, boolean $isNew= false
, string $name= null
, array $context= array()
, boolean $isPost= false
) : \MUtil_Date | \Zend_Db_Expr | string
If empty or \Zend_Db_Expression (after save) it will return just the value currently there are no checks for a valid date format.
see |
---|
mixed
The value being saved
boolean
True when a new item is being saved
string
The name of the current field
array
Optional, the other values being saved
boolean
True when passing on post data
\MUtil_Date
\Zend_Db_Expr
string
calculateTrackUsage(mixed $value, boolean $isNew= false
, string $name= null
, array $context= array()
, boolean $isPost= false
) : \MUtil_Date | \Zend_Db_Expr | string
If empty or \Zend_Db_Expression (after save) it will return just the value currently there are no checks for a valid date format.
see |
---|
mixed
The value being saved
boolean
True when a new item is being saved
string
The name of the current field
array
Optional, the other values being saved
boolean
True when passing on post data
\MUtil_Date
\Zend_Db_Expr
string
checkAction()
checkAllAction()
createAction()
deactivateAction()
deleteAction()
editAction()
excelAction()
When you want to change the output, there are two places to check:
$this->addExcelColumns($model), where the model can be changed to have labels for columns you need exported
exportAction()
formatDescription(string $value) : \MUtil_Html_Raw
string
\MUtil_Html_Raw
getBrowseColumns() : array
Must be an array of arrays containing the input for TableBridge->setMultisort()
array
or falsegetCreateTitle() : \$string
\$string
getDeactivateQuestion() : \$string
\$string
getDeactivateTitle() : \$string
\$string
getDefaultImportTranslator() : string
string
getDeleteQuestion() : \$string
\$string
getDeleteTitle() : \$string
\$string
getEditTitle() : \$string
\$string
getImportTempDirectory() : string
string
getImportTranslators() : array
array
of \MUtil_Model_ModelTranslatorInterface objectsgetImporter() : \MUtil_Model_Importer
\MUtil_Model_Importer
getIndexTitle() : \$string
inherited_from | \Gems_Controller_ModelSnippetActionAbstract::getIndexTitle() |
---|
\$string
getIndexTitle() : \$string
\$string
getInstanceId() : mixed
Overrule this function if the last item in the page title should be something other than te value of \MUtil_Model::REQUEST_ID.
mixed
getOnEmptyText() : string
string
getReactivateQuestion() : \$string
\$string
getReactivateTitle() : \$string
\$string
getSearchFilter(boolean $useRequest = true
) : array
.
boolean
Use the request as source (when false, the session is used)
array
or falsegetShowTitle() : \$string
\$string
getSurveyId() : integer
integer
getTitle(string $separator = null
) : string
If the title is an array the seperator concatenates the parts.
string
string
getTopic(integer $count = 1
) : \$string
inherited_from | \Gems_Controller_ModelSnippetActionAbstract::getTopic() |
---|
integer
\$string
getTopic(integer $count = 1
) : \$string
integer
\$string
getTopicCallable() : callable
callable
importAction()
indexAction()
initHtml(boolean $reset = false
) : void
boolean
Throws away any existing html output when true
pdfAction()
reactivateAction()
showAction()
createModel(boolean $detailed, string $action) : \MUtil_Model_ModelAbstract
The parameters allow you to easily adapt the model to the current action. The $detailed parameter was added, because the most common use of action is a split between detailed and summarized actions.
boolean
True when the current action is not in $summarizedActions.
string
The current action.
\MUtil_Model_ModelAbstract
firstAllowedMenuItem(string $action, string $action2 = null
) : \Gems_Menu_SubMenuItem
string
string
\Gems_Menu_SubMenuItem
getExcelData(array $data, \MUtil_Model_ModelAbstract $model) : array
array
\MUtil_Model_ModelAbstract
array
getExportModel() :
loadSnippetLoader()
$accesslog : \Gems_AccessLog
$cacheTags : array
array('surveys', 'tracks')
$currentUser : \Gems_User_User
$db : \Zend_Db_Adapter_Abstract
$escort : \GemsEscort
$formatExcelData : boolean
true
$loader : \Gems_Loader
inherited_from | \Gems_Controller_ModelSnippetActionAbstract::loader |
---|
$loader : \Gems_Loader
$project : \Gems_Project_ProjectSettings
$util : \Gems_Util
$autofilterParameters : array
array('columns' => 'getBrowseColumns', 'extraSort' => array('gsu_survey_name' => SORT_ASC), 'menuEditActions' => array('edit', 'pdf'))
When the value is a function name of that object, then that functions is executed with the array key as single parameter and the return value is set as the used value
$autofilterSnippets : mixed
'ModelTableSnippetGeneric'
$createEditParameters : array
array('surveyId' => 'getSurveyId')
When the value is a function name of that object, then that functions is executed with the array key as single parameter and the return value is set as the used value
$createEditSnippets : mixed
array('ModelFormSnippetGeneric', 'Survey\\SurveyQuestionsSnippet')
inherited_from | \Gems_Controller_ModelSnippetActionAbstract::createEditSnippets |
---|
$createEditSnippets : mixed
'ModelFormSnippetGeneric'
$deleteSnippets : mixed
'ModelItemYesNoDeleteSnippetGeneric'
$exportFormSnippets
'Export\\ExportFormSnippet'
$indexStartSnippets : mixed
array('Generic\\ContentTitleSnippet', 'Survey\\SurveyMaintenanceSearchSnippet')
inherited_from | \Gems_Controller_ModelSnippetActionAbstract::indexStartSnippets |
---|
$indexStartSnippets : mixed
array('Generic\\ContentTitleSnippet', 'AutosearchFormSnippet')
$indexStopSnippets : mixed
'Generic\\CurrentSiblingsButtonRowSnippet'
$showParameters : array
array('surveyId' => 'getSurveyId')
When the value is a function name of that object, then that functions is executed with the array key as single parameter and the return value is set as the used value
$showSnippets : mixed
array('Generic\\ContentTitleSnippet', 'ModelItemTableSnippetGeneric', 'Survey\\SurveyQuestionsSnippet')
inherited_from | \Gems_Controller_ModelSnippetActionAbstract::showSnippets |
---|
$showSnippets : mixed
array('Generic\\ContentTitleSnippet', 'ModelItemTableSnippetGeneric')
$_autofilterExtraParameters : array
array('browse' => true, 'containingId' => 'autofilter_target', 'keyboard' => true, 'onEmpty' => 'getOnEmptyText', 'sortParamAsc' => 'asrt', 'sortParamDesc' => 'dsrt')
$_createExtraParameters : array
array('formTitle' => 'getCreateTitle', 'topicCallable' => 'getTopicCallable')
$_deactivateExtraParameters : array
array('confirmQuestion' => 'getDeactivateQuestion', 'displayTitle' => 'getDeactivateTitle', 'formTitle' => 'getDeactivateTitle', 'topicCallable' => 'getTopicCallable')
$_deleteExtraParameters : array
array('deleteQuestion' => 'getDeleteQuestion', 'displayTitle' => 'getDeleteTitle', 'formTitle' => 'getDeleteTitle', 'topicCallable' => 'getTopicCallable')
$_editExtraParameters : array
array('formTitle' => 'getEditTitle', 'topicCallable' => 'getTopicCallable')
$_importExtraParameters : array
array('formatBoxClass' => 'browser table', 'importer' => 'getImporter', 'tempDirectory' => 'getImportTempDirectory', 'topicCallable' => 'getTopic')
$_reactivateExtraParameters : array
array('confirmQuestion' => 'getReactivateQuestion', 'displayTitle' => 'getReactivateTitle', 'formTitle' => 'getReactivateTitle', 'topicCallable' => 'getTopicCallable')