GemsTracker library API
Back to top  

Class description of ShowTrackUsageSnippet

This code contains some display options for excluding or marking a single track and for processing the passed parameters identifying the respondent and the optional single track.

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

 Methods

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

afterRegistry() : void
Inherited

Should be called after answering the request to allow the Target to check if all required registry values have been set correctly.

checkRegistryRequestsAnswers() : boolean
Inherited

Returns

booleanFalse if required are missing.

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

The place to check if the data set in the snippet is valid to generate the snippet.

hasHtmlOutput() : boolean
Inherited

When invalid data should result in an error, you can throw it here but you can also perform the check in the checkRegistryRequestsAnswers() function from the \MUtil_Registry_TargetInterface.

Returns

boolean

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.

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

Make sure generic search text results are marked

applyTextMarker() : void
Inherited

Creates the model

createModel() : \MUtil_Model_ModelAbstract
inherited_from \Gems_Tracker_Snippets_ShowTrackUsageAbstract::createModel()

Returns

\MUtil_Model_ModelAbstract

Creates the model

createModel() : \MUtil_Model_ModelAbstract
Inherited

Returns

\MUtil_Model_ModelAbstract

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

Get a display version of the patient name

getRespondentName() : string
Inherited

Returns

string

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

getTitle() 

getTitle() 
inherited_from \Gems_Tracker_Snippets_ShowTrackUsageAbstract::getTitle()

getTitle() 

getTitle() 
Inherited

Overrule to implement snippet specific filtering and sorting.

processFilterAndSort(\MUtil_Model_ModelAbstract $model) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

 Properties

 

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('gr2t_created' => SORT_DESC)

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

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

The default search data to use.

$defaultSearchData : \array()

Default

array()
 

Optional, when true current item is not shown, when false the current row is marked as the currentRow.

$excludeCurrent : boolean

Default

false
 

Required

$loader : \Gems_Loader

Default

 

Optional, required when using $trackEngine or $trackId only

$organizationId : integer

Default

 

Optional, required when using $trackEngine or $trackId only

$patientId : integer

Default

 

Optional, one of $respondentTrack, $respondentTrackId, $trackEngine, $trackId should be set

$respondentTrack : \Gems_Tracker_RespondentTrack

Default

 

Respondent Track Id

$respondentTrackId : integer

Default

 

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'
 

Optional, one of $respondentTrack, $respondentTrackId, $trackEngine, $trackId should be set

$trackEngine : \Gems_Tracker_Engine_TrackEngineInterface

Default

$trackEngine and TrackId need $patientId and $organizationId to be set as well

 

Optional, one of $respondentTrack, $respondentTrackId, $trackEngine, $trackId should be set

$trackId : integer

Default

$trackEngine and TrackId need $patientId and $organizationId to be set as well