GemsTracker library API
Back to top  

Short description for class

Long description for class (if any)...

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

 Methods

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.

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

Function that allows for overruling the repeater loading.

getRepeater(\MUtil_Model_ModelAbstract $model) : \MUtil_Lazy_RepeatableInterface

Parameters

$model

\MUtil_Model_ModelAbstract

Returns

\MUtil_Lazy_RepeatableInterface

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 rows from the model to the bridge that creates the browse table.

addShowTableRows(\MUtil_Model_Bridge_VerticalTableBridge $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_VerticalTableBridge

$model

\MUtil_Model_ModelAbstract

Creates the model

createModel() : \MUtil_Model_ModelAbstract
Inherited

Returns

\MUtil_Model_ModelAbstract

overrule to add your own buttons.

getMenuList() : \Gems_Menu_MenuList
Inherited

Returns

\Gems_Menu_MenuList

_addIf() 

_addIf(array $names, \MUtil_Model_Bridge_VerticalTableBridge $bridge, \MUtil_Model_ModelAbstract $model) 

Parameters

$names

$bridge

$model

 Properties

 

$menu

$menu : \Gems_Menu

Default

 

One of the \MUtil_Model_Bridge_BridgeAbstract MODE constants

$bridgeMode : integer

Default

\MUtil_Model_Bridge_BridgeAbstract::MODE_SINGLE_ROW
 

Shortfix to add class attribute

$class : string

Default

'displayer'
 

Required

$loader : \Gems_Loader

Default

 

$locale

$locale : \Zend_Locale

Default

 

Gems round id

$roundId : integer

Default

 

Show menu buttons below data

$showMenu : boolean

Default

true
 

Show title above data

$showTitle : boolean

Default

true
 

Optional, required when creating or $trackId should be set

$trackEngine : \Gems_Tracker_Engine_TrackEngineInterface

Default

 

Optional, required when creating or $engine should be set

$trackId : integer

Default

 

True when only tracked fields should be retrieved by the nodel

$trackUsage : boolean

Default

false
 

$util

$util : \Gems_Util

Default

 

$_roundData

$_roundData : array

Default