GemsTracker library API
Back to top  

Handles export of all tracks/surveys for a respondent

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

 Methods

Returns true when this token should be displayed

_displayToken(\Gems_Tracker_Token $token) : boolean

Parameters

$token

\Gems_Tracker_Token

Returns

boolean

addRespondentTrackFilter() 

addRespondentTrackFilter(integer $respTrackId) : \Gems_Export_RespondentExport

Parameters

$respTrackId

integer

Returns

\Gems_Export_RespondentExport

addTokenFilter() 

addTokenFilter(string $tokenId) : \Gems_Export_RespondentExport

Parameters

$tokenId

string

Returns

\Gems_Export_RespondentExport

Called after the check that all required registry values have been set correctly has run.

afterRegistry() : void

Constructs the form

getForm(boolean $hideGroup = false) : \Gems_Form_TableForm

Parameters

$hideGroup

boolean

When true group checkbox is hidden

Returns

\Gems_Form_TableForm

Renders the entire report (including layout)

render($respondents, boolean $group = true, string $format = 'html') 

Parameters

$respondents

$group

boolean

Group same surveys or not

$format

string

html|pdf, the output format to use

Exports a single respondent

_exportRespondent(string $respondentId) 

Parameters

$respondentId

string

Exports a single track

_exportTrack(\Gems_Tracker_RespondentTrack $respTrack) 

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

Exports all the tokens of a single track, grouped by round

_exportTrackTokens(\Gems_Tracker_RespondentTrack $track) 

Parameters

$track

\Gems_Tracker_RespondentTrack

Determines if this particular token should be included in the report

_isTokenInFilter(\Gems_Tracker_Token $token) : boolean

Parameters

$token

\Gems_Tracker_Token

Returns

booleanThis dummy implementation always returns true

Determines if this particular track should be included in the report

_isTrackInFilter(\Gems_Tracker_RespondentTrack $track) : boolean

Parameters

$track

\Gems_Tracker_RespondentTrack

Returns

booleanThis dummy implementation always returns true

 Properties

 

Holds the optional token filter.

$tokenFilter : array

Default

array()

When set, a token needs to have all elements in the tokenFilter in order to have _isTokenInFilter return true. The tokenFilter is an array containing an array with one or more of the following elements:

 code            The track code
 surveyid        The survey ID
 tokenid         the token ID
 

Holds the optional track filter.

$trackFilter : array

Default

array()

When set, a track needs to have all elements in the trackFilter in order to have _isTrackInFilter return true. The trackFilter is an array containing an array with one or more of the following elements:

 code            The track code
 trackid         The track ID
 resptrackid     The respondent-track ID
 respid          The respondent ID
 

$_pdf

$_pdf : \Gems_Pdf

Default

 

$_reportFooter

$_reportFooter : string

Default

'Export_ReportFooterSnippet'
 

$_reportHeader

$_reportHeader : string

Default

'Export_ReportHeaderSnippet'
 

$_respondentSnippet

$_respondentSnippet : string

Default

'Export_RespondentSnippet'
 

$currentUser

$currentUser : \Gems_User_User

Default

 

$escort

$escort : \GemsEscort

Default

 

$html

$html : \MUtil_Html_Sequence

Default

 

$loader

$loader : \Gems_Loader

Default

 

Required

$menu : \Gems_Menu

Default

 

$project

$project : \Gems_Project_ProjectSettings

Default

 

Required

$request : \Zend_Controller_Request_Abstract

Default

 

$util

$util : \Gems_Util

Default

 

$view

$view : \Zend_View

Default