GemsTracker library API
Back to top  

Generic extension for displaying tokens

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

 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

Returns

booleanFalse if required are missing.

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

Creates a fake form so that it is (slightly) easier to copy and paste a token.

makeFakeForm(string $value) : \Gems_Form
Static

Parameters

$value

string

Gems token value

Returns

\Gems_Form

Creates the model

createModel() : \MUtil_Model_ModelAbstract

Returns

\MUtil_Model_ModelAbstract

getTitle() 

getTitle() : string

Returns

stringThe header title to display

 Properties

 

Shortfix to add class attribute

$class : string

Default

'displayer table table-bordered table-condensed'
 

Required

$loader : \Gems_Loader

Default

 

Required

$menu : \Gems_Menu

Default

 

Required

$request : \Zend_Controller_Request_Abstract

Default

 

Optional: $request or $tokenData must be set

$token : \Gems_Tracker_Token

Default

The display data of the token shown

 

Optional: id of the selected token to show

$tokenId : string

Default

Can be derived from $request or $token

 

Show the token in an mini form for cut & paste.

$useFakeForm : boolean

Default

true

But only when the token is not answered.