GemsTracker library API
Back to top  

Show a single button for an unanswered survey or nothing.

Works using $project->getAskDelay()

package Gems
subpackage Snippets\Ask
copyright Copyright (c) 2012 Erasmus MC
license New BSD License
since Class available since version 1.5.3
inherited_from \Gems_Tracker_Snippets_ShowTokenLoopAbstract

 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_from \Gems_Tracker_Snippets_ShowTokenLoopAbstract::checkRegistryRequestsAnswers()

Returns

booleanFalse if required are missing.

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.

Formats an completion date for this display

formatCompletion(\MUtil_Date $dateTime) : string
Inherited

Parameters

$dateTime

\MUtil_Date

Returns

string

Returns the duration if it should be displayed.

formatDuration(string $duration) : string
Inherited

Parameters

$duration

string

Returns

string

Formats an until date for this display

formatUntil(\MUtil_Date $dateTime = null) : string
Inherited

Parameters

$dateTime

\MUtil_Date

Returns

string

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

Get the href for a token

getTokenHref(\Gems_Tracker_Token $token) : \MUtil_Html_HrefArrayAttribute
Inherited

Parameters

$token

\Gems_Tracker_Token

Returns

\MUtil_Html_HrefArrayAttribute

 Properties

 

General date format

$dateFormat : string

Default

'd MMMM yyyy'
 

Required

$project : \Gems_Project_ProjectSettings

Default

 

Required

$request : \Zend_Controller_Request_Abstract

Default

 

Switch for showing the duration.

$showDuration : boolean

Default

true
 

Optional, calculated from $token

$showToken : \Gems_Tracker_Token

Default

 

Required, the current token, possibly already answered

$token : \Gems_Tracker_Token

Default

 

Required

$view : \Zend_View

Default

 

Was this token already answered? Calculated from $token

$wasAnswered : boolean

Default