GemsTracker library API » \Gems_Default

Methods
» Protected

Controller for looking at mail activity

package	Gems
subpackage	Default
copyright	Copyright (c) 2011 Erasmus MC
license	New BSD License
since	Class available since version 1.4
inherited_from	\Gems_Default_RespondentChildActionAbstract

Methods

The automatically filtered result

autofilterAction($resetMvc = true)

Inherited

Parameters

$resetMvc

When true only the filtered resulsts

Action for showing a create new item page with extra title

createAction()

Inherited

Creates a model for getModel(). Called only for each new $action.

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.

Parameters

$detailed

boolean

True when the current action is not in $summarizedActions.

$action

string

The current action.

Returns

\MUtil_Model_ModelAbstract

Action for showing a deactivate item page with extra titles

deactivateAction()

Inherited

Action for showing a delete item page with extra titles

deleteAction()

Inherited

Action for showing a edit item page with extra title

editAction()

Inherited

Outputs the model to excel, applying all filters and searches needed

excelAction()

Inherited

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
$this->getExcelData($data, $model) where the supplied data and model are merged to get output (by default all fields from the model that have a label)

Export model data

exportAction()

Inherited

Helper function to get the informed title for the index action.

getContentTitle() : \$string

Returns

\$string

Helper function to get the title for the create action.

getCreateTitle() : \$string

Inherited

Returns

\$string

Helper function to get the question for the deactivate action.

getDeactivateQuestion() : \$string

Inherited

Returns

\$string

Helper function to get the title for the deactivate action.

getDeactivateTitle() : \$string

Inherited

Returns

\$string

Name of the default import translator

getDefaultImportTranslator() : string

Inherited

Returns

string

Helper function to get the question for the delete action.

getDeleteQuestion() : \$string

Inherited

Returns

\$string

Helper function to get the title for the delete action.

getDeleteTitle() : \$string

Inherited

Returns

\$string

Helper function to get the title for the edit action.

getEditTitle() : \$string

Inherited

Returns

\$string

The directory to use for temporary storage

getImportTempDirectory() : string

Inherited

Returns

string

Get the possible translators for the import snippet.

getImportTranslators() : array

Inherited

Returns

arrayof \MUtil_Model_ModelTranslatorInterface objects

Get an Importer object for this actions

getImporter() : \MUtil_Model_Importer

Inherited

Returns

\MUtil_Model_Importer

Helper function to get the title for the index action.

getIndexTitle() : \$string

Inherited

Returns

\$string

Return the current request ID, if any.

getInstanceId() : mixed

Inherited

Overrule this function if the last item in the page title should be something other than te value of \MUtil_Model::REQUEST_ID.

Returns

mixed

Returns the on empty texts for the autofilter snippets

getOnEmptyText() : string

Inherited

Returns

string

Helper function to get the question for the reactivate action.

getReactivateQuestion() : \$string

Inherited

Returns

\$string

Helper function to get the title for the reactivate action.

getReactivateTitle() : \$string

Inherited

Returns

\$string

Retrieve the respondent id (So we don't need to repeat that for every snippet.)

getRespondentId() : integer

Inherited

Returns

integer

Get the filter to use with the model for searching

getSearchFilter(boolean $useRequest = true) : array

Parameters

$useRequest

boolean

Use the request as source (when false, the session is used)

Returns

arrayor false

Helper function to get the title for the show action.

getShowTitle() : \$string

Inherited

Returns

\$string

Returns the current html/head/title for this page.

getTitle(string $separator = null) : string

Inherited

If the title is an array the seperator concatenates the parts.

Parameters

$separator

string

Returns

string

Helper function to allow generalized statements about the items in the model.

getTopic(integer $count = 1) : \$string

Parameters

$count

integer

Returns

\$string

Helper function to allow generalized statements about the items in the model.

getTopic(integer $count = 1) : \$string

Inherited

Parameters

$count

integer

Returns

\$string

Get a callable for the gettopic function

getTopicCallable() : callable

Inherited

Returns

callable

Generic model based import action

importAction()

Inherited

Action for showing a browse page

indexAction()

Inherited

Intializes the html component.

initHtml(boolean $reset = false) : void

Inherited

Parameters

$reset

boolean

Throws away any existing html output when true

Action for showing a reactivate item page with extra titles

reactivateAction()

Inherited

Action for showing an item page with title

showAction()

Inherited

Finds the first item with one of the actions specified as parameter and using the current controller

firstAllowedMenuItem(string $action, string $action2 = null) : \Gems_Menu_SubMenuItem

Inherited

Parameters

$action

string

$action2

string

Returns

\Gems_Menu_SubMenuItem

Returns an array with all columns from the model that have a label

getExcelData(array $data, \MUtil_Model_ModelAbstract $model) : array

Inherited

Parameters

$data

array

$model

\MUtil_Model_ModelAbstract

Returns

array

Get the model for export and have the option to change it before using for export

getExportModel() :

Inherited

Returns

Get the respondent object

getRespondent() : \Gems_Tracker_Respondent

inherited_from	\Gems_Default_RespondentChildActionAbstract::getRespondent()

Returns

\Gems_Tracker_Respondent

Get the respondent object

getRespondent() : \Gems_Tracker_Respondent

Inherited

Returns

\Gems_Tracker_Respondent

isMultiTracks()

isMultiTracks() : boolean

Inherited

Returns

boolean

Stub for overruling default snippet loader initiation.

loadSnippetLoader()

Inherited

Properties

$escort

$escort : \GemsEscort

Default

Should Excel output contain formatted data (date fields, select lists)

$formatExcelData : boolean

Default

true

$loader

$loader : \Gems_Loader

Default

$menu

$menu : \Gems_Menu

Default

$util

$util : \Gems_Util

Default

The parameters used for the autofilter action.

$autofilterParameters : array

Default

array('browse' => true, 'containingId' => 'autofilter_target', 'keyboard' => true, 'onEmpty' => 'getOnEmptyText', 'sortParamAsc' => 'asrt', 'sortParamDesc' => 'dsrt', 'extraSort' => array('grco_created' => SORT_DESC))

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

unless the key is an integer in which case the code is executed but the return value is not stored.

The snippets used for the autofilter action.

$autofilterSnippets : mixed

Default

'Mail\\Log\\MailLogBrowseSnippet'

The snippets used for the autofilter action.

$autofilterSnippets : mixed

Default

'ModelTableSnippetGeneric'

The snippets used for the create and edit actions.

$createEditSnippets : mixed

Default

'ModelFormSnippetGeneric'

Model level parameters used for all actions, overruled by any values set in any other parameters array except the private $_defaultParamters values in this module.

$defaultParameters : array

Default

array('multiTracks' => 'isMultiTracks', 'respondent' => 'getRespondent')

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

unless the key is an integer in which case the code is executed but the return value is not stored.

The default search data to use.

$defaultSearchData : \array()

Default

array(\Gems_Snippets_AutosearchFormSnippet::PERIOD_DATE_USED => 'grco_created')

The snippets used for the delete action.

$deleteSnippets : mixed

Default

'ModelItemYesNoDeleteSnippetGeneric'

$exportFormSnippets

$exportFormSnippets

Default

'Export\\ExportFormSnippet'

The parameters used for the import action

$importParameters : array

Default

array('respondent' => null)

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

unless the key is an integer in which case the code is executed but the return value is not stored.

The parameters used for the index action minus those in autofilter.

$indexParameters : array

Default

array('contentTitle' => 'getContentTitle')

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

unless the key is an integer in which case the code is executed but the return value is not stored.

The snippets used for the index action, before those in autofilter

$indexStartSnippets : mixed

Default

array('Generic\\ContentTitleSnippet', 'Mail\\Log\\RespondentMailLogSearchSnippet')

inherited_from	\Gems_Default_RespondentChildActionAbstract::indexStartSnippets

The snippets used for the index action, before those in autofilter

$indexStartSnippets : mixed

Default

array('Generic\\ContentTitleSnippet', 'AutosearchFormSnippet')

The snippets used for the index action, after those in autofilter

$indexStopSnippets : mixed

Default

array('Generic\\CurrentButtonRowSnippet')

The snippets used for the index action, after those in autofilter

$indexStopSnippets : mixed

Default

'Generic\\CurrentSiblingsButtonRowSnippet'

The snippets used for the show action

$showSnippets : mixed

Default

array('Generic\\ContentTitleSnippet', 'ModelItemTableSnippetGeneric')

Gems only parameters used for the autofilter action. Can be overruled by setting $this->autofilterParameters

$_autofilterExtraParameters : array

Default

array('browse' => true, 'containingId' => 'autofilter_target', 'keyboard' => true, 'onEmpty' => 'getOnEmptyText', 'sortParamAsc' => 'asrt', 'sortParamDesc' => 'dsrt')

Gems only parameters used for the create action. Can be overruled by setting $this->createParameters or $this->createEditParameters

$_createExtraParameters : array

Default

array('formTitle' => 'getCreateTitle', 'topicCallable' => 'getTopicCallable')

Gems only parameters used for the deactivate action. Can be overruled by setting $this->deactivateParameters

$_deactivateExtraParameters : array

Default

array('confirmQuestion' => 'getDeactivateQuestion', 'displayTitle' => 'getDeactivateTitle', 'formTitle' => 'getDeactivateTitle', 'topicCallable' => 'getTopicCallable')

Gems only parameters used for the delete action. Can be overruled by setting $this->deleteParameters

$_deleteExtraParameters : array

Default

array('deleteQuestion' => 'getDeleteQuestion', 'displayTitle' => 'getDeleteTitle', 'formTitle' => 'getDeleteTitle', 'topicCallable' => 'getTopicCallable')

Gems only parameters used for the edit action. Can be overruled by setting $this->editParameters or $this->createEditParameters

$_editExtraParameters : array

Default

array('formTitle' => 'getEditTitle', 'topicCallable' => 'getTopicCallable')

Gems only parameters used for the import action. Can be overruled by setting $this->inmportParameters

$_importExtraParameters : array

Default

array('formatBoxClass' => 'browser table', 'importer' => 'getImporter', 'tempDirectory' => 'getImportTempDirectory', 'topicCallable' => 'getTopic')

Gems only parameters used for the deactivate action. Can be overruled by setting $this->deactivateParameters

$_reactivateExtraParameters : array

Default

array('confirmQuestion' => 'getReactivateQuestion', 'displayTitle' => 'getReactivateTitle', 'formTitle' => 'getReactivateTitle', 'topicCallable' => 'getTopicCallable')

$_respondent

$_respondent : \Gems_Tracker_Respondent

Default

inherited_from	\Gems_Default_RespondentChildActionAbstract::_respondent

$_respondent

$_respondent : \Gems_Tracker_Respondent