GemsTracker library API
Back to top  

Simple stub for track model, allows extension by projects and adds auto labelling

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

 Methods

Construct a track model

__construct() 

Sets the labels, format functions, etc.

applyFormatting(boolean $detailed = false, boolean $edit = false) : \Gems_Tracker_Model_TrackModel

..

Parameters

$detailed

boolean

True when shopwing detailed information

$edit

boolean

When true use edit settings

Returns

\Gems_Tracker_Model_TrackModel

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

checkRegistryRequestsAnswers() : boolean

Returns

booleanFalse if required are missing.

When this method returns something other than an empty array it will try to add fields to a newly created track

getDefaultFields() : array

Returns

arrayShould be an array or arrays, containing the default fields

save() 

save(array $newValues, array $filter = null) 

Parameters

$newValues

$filter

Returns a translate adaptor

getTranslateAdapter() : \Zend_Translate_Adapter

Returns

\Zend_Translate_Adapter

 Properties

 

Holds the trackData in array with key trackId, for internal caching use only

$_trackData : array

Default

array()
 

$loader

$loader : \Gems_Loader

Default

 

$tracker

$tracker : \Gems_Tracker

Default

 

$translate

$translate : \Zend_Translate

Default

 

$util

$util : \Gems_Util

Default