GemsTracker library API » \Gems_Tracker_Token

Helps building select statements for the Token model

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

Methods

__construct()

__construct(\Zend_Db_Adapter_Abstract $db, \type $fields = "*")

Parameters

$db

\Zend_Db_Adapter_Abstract

Adapter to use

$fields

\type

Optional select fieldlist

__toString()

__toString() : string

Returns

stringSQL Select statement

Add consent descriptions to the select statement

andConsents(string|array $fields = '*') : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

Returns

\Gems_Tracker_Token_TokenSelect

andReceptionCodes()

andReceptionCodes(string|array $fields = '*') : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

Returns

\Gems_Tracker_Token_TokenSelect

Add RespondentOrganization info to the select statement

andRespondentOrganizations(string|array $fields = '*') : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

Returns

\Gems_Tracker_Token_TokenSelect

Add Respondent Track info to the select statement

andRespondentTracks(string|array $fields = '*', boolean $groupBy = false) : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

$groupBy

boolean

Optional, add these fields to group by statement

Returns

\Gems_Tracker_Token_TokenSelect

Add Respondent info to the select statement

andRespondents(string|array $fields = '*') : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

Returns

\Gems_Tracker_Token_TokenSelect

Adds round info to the select statement

andRounds(string|array $fields = '*') : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

Returns

\Gems_Tracker_Token_TokenSelect

Add survey info to the select statement

andSurveys(string|array $fields = '*') : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

Returns

\Gems_Tracker_Token_TokenSelect

Add track info to the select statement

andTracks(string|array $fields = '*', boolean $groupBy = false) : \Gems_Tracker_Token_TokenSelect

Parameters

$fields

stringarray

$groupBy

boolean

Optional, add these fields to group by statement

Returns

\Gems_Tracker_Token_TokenSelect

fetchAll()

fetchAll() : array

Returns

array

fetchOne()

fetchOne() : mixed

Returns

mixed

fetchRow()

fetchRow() : array

Returns

array

Select only a specific group

forGroupId(integer $groupId) : \Gems_Tracker_Token_TokenSelect

Parameters

$groupId

integer

Gems group id

Returns

\Gems_Tracker_Token_TokenSelect

Select the token before the current token

forNextTokenId($tokenId) : \Gems_Tracker_Token_TokenSelect

Parameters

$tokenId

Returns

\Gems_Tracker_Token_TokenSelect

Select the token before the current token

forPreviousTokenId($tokenId) : \Gems_Tracker_Token_TokenSelect

Parameters

$tokenId

Returns

\Gems_Tracker_Token_TokenSelect

Select only a specific respondent

forRespondent(string $respondentId, string $organizationId = null) : \Gems_Tracker_Token_TokenSelect

Parameters

$respondentId

string

$organizationId

string

Optional

Returns

\Gems_Tracker_Token_TokenSelect

Select only for a specific Respondent Track ID

forRespondentTrack(integer $respTrackId) : \Gems_Tracker_Token_TokenSelect

Parameters

$respTrackId

integer

Respondent Track ID

Returns

\Gems_Tracker_Token_TokenSelect

Select only for a specific Round ID

forRound(integer $roundId) : \Gems_Tracker_Token_TokenSelect

Parameters

$roundId

integer

Round ID

Returns

\Gems_Tracker_Token_TokenSelect

Select only a specific surveyId

forSurveyCode($surveyCode) : \Gems_Tracker_Token_TokenSelect

Parameters

$surveyCode

Returns

\Gems_Tracker_Token_TokenSelect

Select only a specific surveyId

forSurveyId(string $surveyId) : \Gems_Tracker_Token_TokenSelect

Parameters

$surveyId

string

Returns

\Gems_Tracker_Token_TokenSelect

Select only a specific tokenId

forTokenId(string $tokenId) : \Gems_Tracker_Token_TokenSelect

Parameters

$tokenId

string

Returns

\Gems_Tracker_Token_TokenSelect

For adding generic where statements

forWhere(string $cond, mixed $bind = null) : \Gems_Tracker_Token_TokenSelect

Parameters

$cond

string

SQL Where condition.

$bind

mixed

optional bind values

Returns

\Gems_Tracker_Token_TokenSelect

Get the constructed select statement

getSelect() : \Zend_Db_Select

Returns

\Zend_Db_Select

Select only active tokens

onlyActive(boolean $recentCheck = false) : \Gems_Tracker_Token_TokenSelect

Active is token already in surveyor and completiondate is null

Parameters

$recentCheck

boolean

Check only tokens with recent gto_start_time's

Returns

\Gems_Tracker_Token_TokenSelect

Select only completed tokens

onlyCompleted() : \Gems_Tracker_Token_TokenSelect

Comleted is token has a completiondate

Returns

\Gems_Tracker_Token_TokenSelect

Select tokens with receptioncodes with the success status 1

onlySucces() : \Gems_Tracker_Token_TokenSelect

Returns

\Gems_Tracker_Token_TokenSelect

Select only valid tokens

onlyValid() : \Gems_Tracker_Token_TokenSelect

Not answered, and valid_from/to in right range

Returns

\Gems_Tracker_Token_TokenSelect

order()

order(mixed $spec) : \Gems_Tracker_Token_TokenSelect

Parameters

$spec

mixed

The column(s) and direction to order by.

Returns

\Gems_Tracker_Token_TokenSelect

Do not select the current token

withoutToken(string $tokenId) : \Gems_Tracker_Token_TokenSelect

Parameters

$tokenId

string

Returns

\Gems_Tracker_Token_TokenSelect

Properties

$db

$db : \Zend_Db_Adapter_Abstract

Default

$sql_select

$sql_select : \Zend_Db_Select