GemsTracker library API
Back to top  

package Gems
subpackage Snippets\Tracker
copyright Copyright (c) 2015 Erasmus MC
license New BSD License
since Class available since version 1.7.2 9-sep-2015 18:36:59
inherited_from \Gems\Snippets\Generic\ContentTitleSnippet

 Methods

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

afterRegistry() : void

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 values 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

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

 Properties

 

The title to display

$contentTitle : string

Default

 

Tagname of the HtmlElement to create

$tagName : string

Default

'h3'
 

Required: the engine of the current track

$trackEngine : \Gems_Tracker_Engine_TrackEngineInterface

Default