GemsTracker library API
Back to top  

Snippet for showing the all tokens for a single respondent.

Adds columns to the model and adds extra logic for calc_used_date sorting.

package Gems
subpackage Snippets\Token
copyright Copyright (c) 2015 Erasmus MC
license New BSD License
since Class available since version 1.7.2 16-okt-2015 19:04:21
inherited_from \Gems\Snippets\Token\PlanTokenSnippet

 Methods

Called after the check that all required registry values have been set correctly has run.

afterRegistry() : void
Inherited

Return a list of possible action buttons for the token

createActionButtons(\MUtil_Model_Bridge_TableBridge $bridge) : array
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

Returns

arrayof HtmlElements

createMenuLink() 

createMenuLink(mixed $parameterSource, string $controller, string $action = 'index', string $label = null) : \MUtil_Html_AElement
Inherited

Parameters

$parameterSource

mixed

$controller

string

$action

string

$label

string

Returns

\MUtil_Html_AElement

Create the snippets content

getHtmlOutput(\Zend_View_Abstract $view) : \MUtil_Html_HtmlInterface
Inherited

This is a stub function either override getHtmlOutput() or override render()

Parameters

$view

\Zend_View_Abstract

Just in case it is needed here

Returns

\MUtil_Html_HtmlInterfaceSomething that can be rendered

Adds columns from the model to the bridge that creates the browse table.

addBrowseTableColumns(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

Overrule this function to add different columns to the browse table, without having to recode the core table building code.

inherited_from \Gems\Snippets\Token\PlanTokenSnippet::addBrowseTableColumns()

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Adds columns from the model to the bridge that creates the browse table.

addBrowseTableColumns(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void
Inherited

Overrule this function to add different columns to the browse table, without having to recode the core table building code.

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Add the paginator panel to the table.

addPaginator(\MUtil_Html_TableElement $table, \Zend_Paginator $paginator) 
Inherited

Only called when $this->browse is true. Overrule this function to define your own method.

$param \Zend_Paginator $paginator

Parameters

$table

$paginator

As this is a common cell setting, this function allows you to overrule it.

addRespondentCell(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) 
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

addTokenLinks() 

addTokenLinks(\MUtil_Model_Bridge_TableBridge $bridge) 
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

Make sure generic search text results are marked

applyTextMarker() : void
Inherited

Creates the model

createModel() : \MUtil_Model_ModelAbstract
Inherited

Returns

\MUtil_Model_ModelAbstract

Returns a '+' token button

createShowTokenButton(\MUtil_Model_Bridge_TableBridge $bridge) : \MUtil_Html_AElement
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

Returns

\MUtil_Html_AElement

Finds a specific active menu item

findMenuItem(string $defaultController, string|array $actions = 'index') : \Gems_Menu_SubMenuItem
Inherited
deprecated since 1.7.1, use findMenuItems()

Parameters

$defaultController

string

$actions

stringarray

Returns

\Gems_Menu_SubMenuItemThe first that

Finds a specific active menu item

findMenuItems(string $defaultController, string|array $actions = array('index')) : array
Inherited

Parameters

$defaultController

string

$actions

stringarray

Returns

arrayof \Gems_Menu_SubMenuItem

Returns an edit menu item, if access is allowed by privileges

getEditMenuItem() : \Gems_Menu_SubMenuItem
Inherited
deprecated since 1.7.1, use getEditMenuItems()

Returns

\Gems_Menu_SubMenuItem

Returns an edit menu item, if access is allowed by privileges

getEditMenuItems() : \Gems_Menu_SubMenuItem
Inherited

Returns

\Gems_Menu_SubMenuItem

Returns a show menu item, if access is allowed by privileges

getShowMenuItem() : \Gems_Menu_SubMenuItem
Inherited
deprecated since 1.7.1, use getShowMenuItems()

Returns

\Gems_Menu_SubMenuItem

Returns a show menu item, if access is allowed by privileges

getShowMenuItems() : \Gems_Menu_SubMenuItem
Inherited

Returns

\Gems_Menu_SubMenuItem

calc_used_date has special sort, see bugs 108 and 127

sortCalcDateCheck(\MUtil_Model_ModelAbstract $model) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

 Properties

 

Sets pagination on or off.

$browse : boolean

Default

true
 

Use keyboard to select row

$keyboard : boolean

Default

false
 

Make sure the keyboard id is used only once

$keyboardUsed : boolean

Default

false
Static
 

$menu

$menu : \Gems_Menu

Default

 

The default controller for menu actions, if null the current controller is used.

$menuActionController : array

Default

null
 

Menu actions to show in Edit box.

$menuEditActions : array

Default

array('edit')

If controller is numeric $menuActionController is used, otherwise the key specifies the controller.

 

Menu actions to show in Show box.

$menuShowActions : array

Default

array('show')

If controller is numeric $menuActionController is used, otherwise the key specifies the controller.

 

Set a fixed model sort.

$_fixedSort : array

Default

array('respondent_name' => SORT_ASC, 'gr2o_patient_nr' => SORT_ASC, 'gtr_track_name' => SORT_ASC, 'gtr_track_info' => SORT_ASC, 'gr2t_track_info' => SORT_ASC, 'gto_round_description' => SORT_ASC)

Leading _ means not overwritten by sources.

inherited_from \Gems\Snippets\Token\PlanTokenSnippet::_fixedSort
 

Set a fixed model sort.

$_fixedSort : array

Default

array('calc_used_date' => SORT_ASC, 'gtr_track_name' => SORT_ASC, 'gto_round_order' => SORT_ASC, 'gto_created' => SORT_ASC)

Leading _ means not overwritten by sources.

 

Shortfix to add class attribute

$class : string

Default

'browser table'
 

The id of a div that contains the table.

$containingId : string

Default

 

The default search data to use.

$defaultSearchData : \array()

Default

array()
 

$loader

$loader : \Gems_Loader

Default

 

A model, not necessarily the token model

$model : \MUtil_Model_ModelAbstract

Default

 

$multiTracks

$multiTracks : boolean

Default

true
 

Option to manually diasable the menu

$showMenu : boolean

Default

true
 

The $request param that stores the ascending sort

$sortParamAsc : string

Default

'asrt'
 

The $request param that stores the descending sort

$sortParamDesc : string

Default

'dsrt'