GemsTracker library API
Back to top  

Display snippet for standard track tokens

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

 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
Inherited

Returns

booleanFalse if required 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

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

makeFakeForm(string $value) : \Gems_Form
InheritedStatic

Parameters

$value

string

Gems token value

Returns

\Gems_Form

Adds rows from the model to the bridge that creates the browse table.

addShowTableRows(\MUtil_Model_Bridge_VerticalTableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

Overrule this function to add different columns to the browse table, without having to recode the core table building code.

Parameters

$bridge

\MUtil_Model_Bridge_VerticalTableBridge

$model

\MUtil_Model_ModelAbstract

Creates the model

createModel() : \MUtil_Model_ModelAbstract
Inherited

Returns

\MUtil_Model_ModelAbstract

getMenuList() 

getMenuList() : \Gems_Menu_MenuList

Returns

\Gems_Menu_MenuList

getTitle() 

getTitle() : string
inherited_from \Gems_Tracker_Snippets_ShowTokenSnippetAbstract::getTitle()

Returns

stringThe header title to display

getTitle() 

getTitle() : string
Inherited

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.