GemsTracker library API » \Gems\Snippets\Tracker\TrackUsageTextDetailsSnippet

Methods
- Create the snippets content
```
getHtmlOutput()
```
- The place to check if the data set in the snippet is valid to generate the snippet.
```
hasHtmlOutput()
```
Properties

Describes the use of a track in a text paragraph.

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

Methods

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

Properties

$db

$db : \Zend_Db_Adapter_Abstract

Default

Are we working in a multi tracks environment?

$multiTracks : boolean

Default

true

When true the name is show as a header

$showHeader : boolean

Default

false

Optional: the display data of the track shown

$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