GemsTracker library API
Back to top  

Shows the survey rounds in a track

package Gems
subpackage Snippets_Tracker
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.1
inherited_from \Gems_Snippets_MenuSnippetAbstract

 Methods

findMenuItem() 

findMenuItem(string $controller, string $action = 'index') : \Gems_Menu_SubMenuItem
Inherited

Parameters

$controller

string

$action

string

Returns

\Gems_Menu_SubMenuItem

Create the snippets content

getHtmlOutput(\Zend_View_Abstract $view) : \MUtil_Html_HtmlInterface

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

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

oneLine() 

oneLine($line) 
Static

Parameters

$line

getRepeater() 

getRepeater($trackId) 

Parameters

$trackId

 Properties

 

$menu

$menu : \Gems_Menu

Default

 

Optional: the name of the track

$trackName : integer

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$loader

$loader : \Gems_Loader

Default

 

Optional: alternative source for the data above

$trackData : array

Default

 

Optional, can be source of the $trackId

$trackEngine : \Gems_Tracker_Engine_TrackEngineInterface

Default

 

REQUIRED: the id of the track shown

$trackId : integer

Default

Or must be extracted from $trackData or $trackEngine