GemsTracker library API
Back to top  

Displays a respondent's details with assigned surveys and tracks in extra columns.

package Gems
subpackage Snippets
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.1
inherited_from \Gems_Snippets_RespondentDetailSnippetAbstract

 Methods

Check if we have the 'Unknown' consent, and present a warning. The project default consent is normally 'Unknown' but this can be overruled in project.ini so checking for default is not right

checkConsent(string $consent) 
InheritedStatic
static boolean $warned We need only one warning in case of multiple consents

Parameters

$consent

string

findMenuItem() 

findMenuItem(string $controller, string $action = 'index') : \Gems_Menu_SubMenuItem
Inherited

Parameters

$controller

string

$action

string

Returns

\Gems_Menu_SubMenuItem

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

addButtons() 

addButtons(\MUtil_Model_Bridge_VerticalTableBridge $bridge) : void
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_VerticalTableBridge

addOnClick() 

addOnClick(\MUtil_Model_Bridge_VerticalTableBridge $bridge) : void
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_VerticalTableBridge

Place to set the data to display

addTableCells(\MUtil_Model_Bridge_VerticalTableBridge $bridge) : void
inherited_from \Gems_Snippets_RespondentDetailSnippetAbstract::addTableCells()

Parameters

$bridge

\MUtil_Model_Bridge_VerticalTableBridge

Place to set the data to display

addTableCells(\MUtil_Model_Bridge_VerticalTableBridge $bridge) : void
Inherited

Parameters

$bridge

\MUtil_Model_Bridge_VerticalTableBridge

Returns the caption for this table

getCaption(boolean $onlyNotCurrent = false) : string
Inherited

Parameters

$onlyNotCurrent

boolean

Only return a string when the organization is different

Returns

string

 Properties

 

$menu

$menu : \Gems_Menu

Default

 

$util

$util : \Gems_Util

Default

inherited_from \Gems_Snippets_RespondentDetailSnippetAbstract::util
 

Optional: array of buttons

$buttons : array

Default

 

$loader

$loader : \Gems_Loader

Default

 

$model

$model : \Gems_Model_RespondentModel

Default

 

Optional: href for onclick

$onclick : \MUtil_Html_HrefArrayAttribute

Default

 

Optional: repeater respondent data

$repeater : \MUtil_Lazy_RepeatableInterface

Default

 

Require

$request : \Zend_Controller_Request_Abstract

Default

inherited_from \Gems_Snippets_RespondentDetailSnippetAbstract::request
 

Required

$request : \Zend_Controller_Request_Abstract

Default

 

Optional

$respondent : \Gems_Tracker_Respondent

Default

 

Optional: set display of buttons on or off

$showButtons : boolean

Default

true
 

Show a warning if informed consent has not been set

$showConsentWarning : boolean

Default

true
 

$util

$util : \Gems_Util

Default

 

$view

$view : \Zend_View

Default