GemsTracker library API
Back to top  

Action controller, initialises the html object

package Gems
subpackage Default
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.0
inherited_from \Gems_Controller_Action

 Methods

Adds one or more messages to the session based message store.

addMessage($message, $status = null) : \MUtil_Controller_Action
Inherited

Parameters

$message

$status

Returns

\MUtil_Controller_Action

Show the user a screen with token information and a button to take at least one survey

forwardAction() : void

Returns a session based message store for adding messages to.

getMessenger() : \Zend_Controller_Action_Helper_FlashMessenger
Inherited

Returns

\Zend_Controller_Action_Helper_FlashMessenger

Ask the user for a token

indexAction() : void

Intializes the html component.

initHtml(boolean $reset = false) : void
Inherited

Parameters

$reset

boolean

Throws away any existing html output when true

The action where survey sources should return to after survey completion

returnAction() 

Set the session based message store.

setMessenger(\Zend_Controller_Action_Helper_FlashMessenger $messenger) : \MUtil_Controller_Action
Inherited

Parameters

$messenger

\Zend_Controller_Action_Helper_FlashMessenger

Returns

\MUtil_Controller_Action

Duplicate of to-survey to enable separate rights

takeAction() 

Go directly to url

toSurveyAction() 

Old action mentioned on some documentation

tokenAction() 

Common handler utility to initialize tokens from parameters

_initToken() : boolean

Returns

booleanTrue if there is a real token specified in the request

Function for overruling the display of the login form.

displayTokenForm(\Gems_Tracker_Form_AskTokenForm $form) 

Parameters

$form

\Gems_Tracker_Form_AskTokenForm

Stub for overruling default snippet loader initiation.

loadSnippetLoader() 
Inherited

 Properties

 

$currentUser

$currentUser : \Gems_User_User

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$loader

$loader : \Gems_Loader

Default

 

$locale

$locale : \Zend_Locale

Default

 

$messenger

$messenger : \Zend_Controller_Action_Helper_FlashMessenger

Default

 

Set to true in child class for automatic creation of $this->html.

$useHtmlView : boolean

Default

true

To initiate the use of $this->html from the code call $this->initHtml()

Overrules $useRawOutput.

see
 

$util

$util : \Gems_Util

Default

 

$forwardSnippets

$forwardSnippets 

Default

'Ask\\ShowFirstOpenSnippet'
 

The width factor for the label elements.

$labelWidthFactor : float

Default

0.8

Width = (max(characters in labels) * labelWidthFactor) . 'em'

 

The current token

$token : \Gems_Tracker_Token

Default

set by _initToken()

 

The current token ID

$tokenId : \Gems_Tracker

Default

set by _initToken()

 

The tracker

$tracker : \Gems_Tracker

Default

set by _initToken()