GemsTracker library API
Back to top  

Step engine that can select any previous round for begin date and any round for calculating the end date.

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

 Methods

__construct() 

__construct(array $trackData) 
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::__construct()

Parameters

$trackData

array

array containing track record

Integrate field loading en showing and editing

addFieldsToModel(\MUtil_Model_ModelAbstract $model, boolean $addDependency = true, $respTrackId = false) : \Gems_Tracker_Engine_TrackEngineAbstract
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::addFieldsToModel()

Parameters

$model

\MUtil_Model_ModelAbstract

$addDependency

boolean

True when editing, can be false in all other cases

$respTrackId

Optional Database column name where Respondent Track Id is set

Returns

\Gems_Tracker_Engine_TrackEngineAbstract

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

afterRegistry() : void
Inherited

Set menu parameters from this track engine

applyToMenuSource(\Gems_Menu_ParameterSource $source) : \Gems_Tracker_Engine_TrackEngineInterface
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::applyToMenuSource()

Parameters

$source

\Gems_Menu_ParameterSource

Returns

\Gems_Tracker_Engine_TrackEngineInterface(continuation pattern)

Calculate the track info from the fields

calculateFieldsInfo(array $data) : string
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::calculateFieldsInfo()

Parameters

$data

array

The values to save

Returns

stringThe description to save as track_info

Calculate the number of active rounds in this track from the database.

calculateRoundCount() : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::calculateRoundCount()

Returns

integerThe number of rounds in this track.

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.

Check for the existence of all tokens and create them otherwise

checkRoundsFor(\Gems_Tracker_RespondentTrack $respTrack, integer $userId, \Gems_Task_TaskRunnerBatch $batch = null) 
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::checkRoundsFor()

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$userId

integer

Id of the user who takes the action (for logging)

$batch

The end date of any round can depend on any token so always do a end date check of the previous tokens

checkTokensFrom(\Gems_Tracker_RespondentTrack $respTrack, \Gems_Tracker_Token $startToken, integer $userId, \Gems_Tracker_Token $skipToken = null) : integer
inherited_from \Gems_Tracker_Engine_StepEngineAbstract::checkTokensFrom()

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$startToken

\Gems_Tracker_Token

The token to start at

$userId

integer

Id of the user who takes the action (for logging)

$skipToken

\Gems_Tracker_Token

Optional token to skip in the recalculation

Returns

integerThe number of tokens changed by this code

Check the valid from and until dates in the track starting at a specified token

checkTokensFrom(\Gems_Tracker_RespondentTrack $respTrack, \Gems_Tracker_Token $startToken, integer $userId, \Gems_Tracker_Token $skipToken = null) : integer
Inherited

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$startToken

\Gems_Tracker_Token

The token to start at

$userId

integer

Id of the user who takes the action (for logging)

$skipToken

\Gems_Tracker_Token

Optional token to skip in the recalculation

Returns

integerThe number of tokens changed by this code

Check the valid from and until dates in the track

checkTokensFromStart(\Gems_Tracker_RespondentTrack $respTrack, integer $userId) : integer
Inherited

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$userId

integer

Id of the user who takes the action (for logging)

Returns

integerThe number of tokens changed by this code

Convert a TrackEngine instance to a TrackEngine of another type.

convertTo(\type $conversionTargetClass) 
Inherited
see
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::convertTo()

Parameters

$conversionTargetClass

\type

Copy a track and all it's related data (rounds/fields etc)

copyTrack(\inte $oldTrackId) : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::copyTrack()

Parameters

$oldTrackId

\inte

The id of the track to copy

Returns

integerThe id of the copied track

Changes the display of gro_valid_[after|for]_field into something readable

displayDateCalculation(mixed $value, $new, string $name, array $context = array()) : string
Inherited

Parameters

$value

mixed

The value being saved

$new

$name

string

The name of the current field

$context

array

Optional, the other values being saved

Returns

stringThe value to use

Changes the display of gro_valid_[for|after]_id into something readable

displayRoundId(mixed $value, $new, string $name, array $context = array()) : string
Inherited

Makes it empty when not applicable

Parameters

$value

mixed

The value being saved

$new

$name

string

The name of the current field

$context

array

Optional, the other values being saved

Returns

stringThe value to use

An array of snippet names for displaying the answers to a survey.

getAnswerSnippetNames() : array
Inherited

Returns

arrayif string snippet names

Returns a list of classnames this track engine can be converted into.

getConversionTargets(array $options) : array
Inherited

Should always contain at least the class itself.

see
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getConversionTargets()

Parameters

$options

array

The track engine class options available in as a "track engine class names" => "descriptions" array

Returns

arrayFilter or adaptation of $options

A longer description of the workings of the engine.

getDescription() : string

Returns

stringName

Returns an array of the fields in this track key / value are id / field name

getFieldNames() : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldNames()

Returns

arrayfieldid => fieldcode

Get the FieldUpdateEvent for this trackId

getFieldUpdateEvent() : \Gems_TrackFieldUpdateEventInterface
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldUpdateEvent()

Returns

\Gems_TrackFieldUpdateEventInterface| null

Returns an array of the fields in this track key / value are id / code

getFields() : array
Inherited

Returns

arrayfieldid => fieldcode

Returns the field data for the respondent track id.

getFieldsData(integer $respTrackId) : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldsData()

Parameters

$respTrackId

integer

Gems respondent track id or null when new

Returns

arrayof the existing field values for this respondent track

Get the storage model for field values

getFieldsDataStorageModel() : \Gems\Tracker\Model\FieldDataModel
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldsDataStorageModel()

Returns

\Gems\Tracker\Model\FieldDataModel

Returns the field definition for the track enige.

getFieldsDefinition() : \Gems\Tracker\Engine\FieldsDefinition;
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldsDefinition()

Returns

\Gems\Tracker\Engine\FieldsDefinition;

Returns a model that can be used to retrieve or save the field definitions for the track editor.

getFieldsMaintenanceModel(boolean $detailed = false, string $action = 'index') : \Gems\Tracker\Model\FieldMaintenanceModel
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldsMaintenanceModel()

Parameters

$detailed

boolean

Create a model for the display of detailed item data or just a browse table

$action

string

The current action

Returns

\Gems\Tracker\Model\FieldMaintenanceModel

Returns an array name => code of all the fields of the type specified

getFieldsOfType(string $fieldType) : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFieldsOfType()

Parameters

$fieldType

string

Returns

arrayname => code

Get the round id of the first round

getFirstRoundId() : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getFirstRoundId()

Returns

integerGems id of first round

A pretty name for use in dropdown selection boxes.

getName() : string

Returns

stringName

Look up the round id for the next round

getNextRoundId(integer $roundId) : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getNextRoundId()

Parameters

$roundId

integer

Gems round id

Returns

integerGems round id

Look up the round id for the previous round

getPreviousRoundId(integer $roundId, integer $roundOrder = null) : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getPreviousRoundId()

Parameters

$roundId

integer

Gems round id

$roundOrder

integer

Optional extra round order, for when the current round may have changed.

Returns

integerGems round id

Get all respondent relation fields

getRespondentRelationFields() : array
Inherited

Returns an array of field id => field name

Returns

array

Get the round object

getRound(integer $roundId) : \Gems\Tracker\Round
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRound()

Parameters

$roundId

integer

Gems round id

Returns

\Gems\Tracker\Round

Returns a snippet name that can be used to display the answers to the token or nothing.

getRoundAnswerSnippets(\Gems_Tracker_Token $token) : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundAnswerSnippets()

Parameters

$token

\Gems_Tracker_Token

Returns

arrayOf snippet names

Return the Round Changed event name for this round

getRoundChangedEvent(integer $roundId) : \Gems_Event_RoundChangedEventInterface
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundChangedEvent()

Parameters

$roundId

integer

Returns

\Gems_Event_RoundChangedEventInterfaceevent instance or null

Get the defaults for a new round

getRoundDefaults() : array

Returns

arrayOf fieldname => default

Get the defaults for a new round

getRoundDefaults() : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundDefaults()

Returns

arrayOf fieldname => default

The round descriptions for this track

getRoundDescriptions() : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundDescriptions()

Returns

arrayroundId => string

An array of snippet names for editing a round.

getRoundEditSnippetNames() : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundEditSnippetNames()

Returns

arrayof string snippet names

Returns a model that can be used to retrieve or save the data.

getRoundModel(boolean $detailed, string $action) : \MUtil_Model_ModelAbstract
inherited_from \Gems_Tracker_Engine_StepEngineAbstract::getRoundModel()

Parameters

$detailed

boolean

Create a model for the display of detailed item data or just a browse table

$action

string

The current action

Returns

\MUtil_Model_ModelAbstract

Returns a model that can be used to retrieve or save the data.

getRoundModel(boolean $detailed, string $action) : \MUtil_Model_ModelAbstract
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundModel()

Parameters

$detailed

boolean

Create a model for the display of detailed item data or just a browse table

$action

string

The current action

Returns

\MUtil_Model_ModelAbstract

An array of snippet names for editing a round.

getRoundShowSnippetNames() : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRoundShowSnippetNames()

Returns

arrayof string snippet names

Get all the round objects

getRounds() : array
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getRounds()

Returns

arrayof roundId => \Gems\Tracker\Round

An array of snippet names for deleting a token.

getTokenDeleteSnippetNames(\Gems_Tracker_Token $token) : array
Inherited

Parameters

$token

\Gems_Tracker_Token

Allows token status dependent delete snippets

Returns

arrayof string snippet names

An array of snippet names for editing a token.

getTokenEditSnippetNames(\Gems_Tracker_Token $token) : array
Inherited

Parameters

$token

\Gems_Tracker_Token

Allows token status dependent edit snippets

Returns

arrayof string snippet names

Returns a model that can be used to save, edit, etc. the token

getTokenModel() : \Gems_Tracker_Model_StandardTokenModel
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getTokenModel()

Returns

\Gems_Tracker_Model_StandardTokenModel

An array of snippet names for displaying a token

getTokenShowSnippetNames(\Gems_Tracker_Token $token) : array
Inherited

Parameters

$token

\Gems_Tracker_Token

Allows token status dependent show snippets

Returns

arrayof string snippet names

Get the TrackCompletedEvent for this trackId

getTrackCalculationEvent() : \Gems_Event_TrackCalculationEventInterface
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getTrackCalculationEvent()

Returns

\Gems_Event_TrackCalculationEventInterface| null

Get the TrackCompletedEvent for this trackId

getTrackCompletionEvent() : \Gems_Event_TrackCompletedEventInterface | null
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getTrackCompletionEvent()

Returns

\Gems_Event_TrackCompletedEventInterfacenull

An array of snippet names for editing a track.

getTrackCreateSnippetNames() : array
Inherited
deprecated since version 1.7.1 Snippets defined TrackAction

Returns

arrayof string snippet names

An array of snippet names for deleting a track.

getTrackDeleteSnippetNames(\Gems_Tracker_RespondentTrack $respTrack) : array
Inherited
deprecated since version 1.7.1 Snippets defined TrackAction

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

Allows track status dependent edit snippets

Returns

arrayof string snippet names

An array of snippet names for editing a track.

getTrackEditSnippetNames(\Gems_Tracker_RespondentTrack $respTrack) : array
Inherited
deprecated since version 1.7.1 Snippets defined TrackAction

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

Allows track status dependent edit snippets

Returns

arrayof string snippet names

getTrackId() 

getTrackId() : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getTrackId()

Returns

integerThe track id

getTrackName() 

getTrackName() : string
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::getTrackName()

Returns

stringThe gems track name

The track type of this engine

getTrackType() : string
Inherited

Returns

string'T' or 'S'

Is the field an appointment type

isAppointmentField(string $fieldName) : boolean
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::isAppointmentField()

Parameters

$fieldName

string

Returns

boolean

True if the user can create this kind of track in TrackMaintenanceAction.

isUserCreatable() : boolean
Inherited

False if this type of track is created by specialized user interface actions.

Engine level function, should be the same for each class instance.

Returns

boolean

Updates the number of rounds in this track.

updateRoundCount(integer $userId) : integer
Inherited
inherited_from \Gems_Tracker_Engine_TrackEngineInterface::updateRoundCount()

Parameters

$userId

integer

The current user

Returns

integer1 if data changed, 0 otherwise

Updates the model to reflect the values for the current item data

updateRoundModelToItem(\MUtil_Model_ModelAbstract $model, array $itemData, string $language) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

$language

string

(ISO) language string

Helper function for default handling of multi options value sets

_applyOptions(\MUtil_Model_ModelAbstract $model, string $fieldName, array $options, array $itemData) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

$fieldName

string

$options

array

$itemData

array

The current items data

Loads the rounds data for this type of track engine.

_ensureRounds() 
Inherited

Can be overruled by sub classes.

Returns a list of available icons under 'htdocs/pulse/icons'

_getAvailableIcons() : array<mixed,string>
Inherited

Returns

array<mixed,string>

Returns true if the source uses values from another token.

_sourceUsesSurvey(string $source) : boolean
Inherited

Parameters

$source

string

The current source

Returns

boolean

Creates all tokens that should exist, but do not exist

addNewTokens(\Gems_Tracker_RespondentTrack $respTrack, integer $userId) : integer
Inherited

NOTE: When overruling this function you should not create tokens because they were deleted by the user

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$userId

integer

Id of the user who takes the action (for logging)

Returns

integerThe number of tokens created by this code

Set the after dates to be listed for this item and the way they are displayed (if at all)

applyDatesValidAfter(\MUtil_Model_ModelAbstract $model, array $itemData, string $language) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

$language

string

(ISO) language string

Set the for dates to be listed for this item and the way they are displayed (if at all)

applyDatesValidFor(\MUtil_Model_ModelAbstract $model, array $itemData, string $language) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

$language

string

(ISO) language string

Apply respondent relation settings to the round model

applyRespondentRelation(\MUtil_Model_ModelAbstract $model, array $itemData) : boolean
Inherited

For respondent surveys, we allow to set a relation, with possible choices:

null => the respondent 0 => undefined (specifiy when assigning)

0 => the id of the track field of type relation to use

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

Returns

booleanTrue if the update changed values (usually by changed selection lists).

Set the surveys to be listed as valid after choices for this item and the way they are displayed (if at all)

applySurveyListValidAfter(\MUtil_Model_ModelAbstract $model, array $itemData) 
inherited_from \Gems_Tracker_Engine_StepEngineAbstract::applySurveyListValidAfter()

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

Set the surveys to be listed as valid after choices for this item and the way they are displayed (if at all)

applySurveyListValidAfter(\MUtil_Model_ModelAbstract $model, array $itemData) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

Set the surveys to be listed as valid for choices for this item and the way they are displayed (if at all)

applySurveyListValidFor(\MUtil_Model_ModelAbstract $model, array $itemData) 
inherited_from \Gems_Tracker_Engine_StepEngineAbstract::applySurveyListValidFor()

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

Set the surveys to be listed as valid for choices for this item and the way they are displayed (if at all)

applySurveyListValidFor(\MUtil_Model_ModelAbstract $model, array $itemData) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$itemData

array

The current items data

calculateFromDate() 

calculateFromDate(\MUtil_Date $startDate, string $type, integer $period) : \MUtil_Date
Inherited

Parameters

$startDate

\MUtil_Date

$type

string

$period

integer

Returns

\MUtil_Date

calculateUntilDate() 

calculateUntilDate(\MUtil_Date $startDate, string $type, integer $period) : \MUtil_Date
Inherited

Parameters

$startDate

\MUtil_Date

$type

string

$period

integer

Returns

\MUtil_Date

Checks all existing tokens and updates any changes to the original rounds (when necessary)

checkExistingRoundsFor(\Gems_Tracker_RespondentTrack $respTrack, integer $userId) : integer
Inherited

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$userId

integer

Id of the user who takes the action (for logging)

Returns

integerThe number of tokens changed by this code

Create model for rounds. Allowes overriding by sub classes.

createRoundModel() : \Gems_Model_JoinModel
Inherited

Returns

\Gems_Model_JoinModel

Returns the date fields selectable using the current source

getDateOptionsFor($sourceType, integer $roundId, string $language, boolean $validAfter) : \type
Inherited

Parameters

$sourceType

$roundId

integer

Gems round id

$language

string

(ISO) language string

$validAfter

boolean

True if it concenrs _valid_after_ dates

Returns

\type

Get the display values for rounds

getRoundTranslations() : array
Inherited

Returns

arrayroundId => display string

Returns the source choices in an array.

getSourceList(boolean $validAfter, boolean $firstRound, boolean $detailed = true) : array
Inherited

Parameters

$validAfter

boolean

True if it concerns _valid_after_ dates

$firstRound

boolean

List for first round

$detailed

boolean

Return extended info

Returns

arraysource_name => label

Look up the survey id associated with a round

getSurveyId(integer $roundId) : integer
Inherited

Parameters

$roundId

integer

Gems round id

Returns

integerGems survey id

Returns the date to use to calculate the ValidFrom if any

getValidFromDate(string $fieldSource, string $fieldName, integer $prevRoundId, \Gems_Tracker_Token $token, \Gems_Tracker_RespondentTrack $respTrack) : \MUtil_Date
inherited_from \Gems_Tracker_Engine_StepEngineAbstract::getValidFromDate()

Parameters

$fieldSource

string

Source for field from round

$fieldName

string

Name from round

$prevRoundId

integer

Id from round

$token

\Gems_Tracker_Token

$respTrack

\Gems_Tracker_RespondentTrack

Returns

\MUtil_Datedate time or null

Returns the date to use to calculate the ValidFrom if any

getValidFromDate(string $fieldSource, string $fieldName, integer $prevRoundId, \Gems_Tracker_Token $token, \Gems_Tracker_RespondentTrack $respTrack) : \MUtil_Date
Inherited

Parameters

$fieldSource

string

Source for field from round

$fieldName

string

Name from round

$prevRoundId

integer

Id from round

$token

\Gems_Tracker_Token

$respTrack

\Gems_Tracker_RespondentTrack

Returns

\MUtil_Datedate time or null

Returns the date to use to calculate the ValidUntil if any

getValidUntilDate(string $fieldSource, string $fieldName, integer $prevRoundId, \Gems_Tracker_Token $token, \Gems_Tracker_RespondentTrack $respTrack, \MUtil_Date $validFrom) : \MUtil_Date
inherited_from \Gems_Tracker_Engine_StepEngineAbstract::getValidUntilDate()

Parameters

$fieldSource

string

Source for field from round

$fieldName

string

Name from round

$prevRoundId

integer

Id from round

$token

\Gems_Tracker_Token

$respTrack

\Gems_Tracker_RespondentTrack

$validFrom

\MUtil_Date

The calculated new valid from value

Returns

\MUtil_Datedate time or null

Returns the date to use to calculate the ValidUntil if any

getValidUntilDate(string $fieldSource, string $fieldName, integer $prevRoundId, \Gems_Tracker_Token $token, \Gems_Tracker_RespondentTrack $respTrack, \MUtil_Date $validFrom) : \MUtil_Date
Inherited

Parameters

$fieldSource

string

Source for field from round

$fieldName

string

Name from round

$prevRoundId

integer

Id from round

$token

\Gems_Tracker_Token

$respTrack

\Gems_Tracker_RespondentTrack

$validFrom

\MUtil_Date

The calculated new valid from value

Returns

\MUtil_Datedate time or null

Remove the unanswered tokens for inactive rounds.

removeInactiveRounds(\Gems_Tracker_RespondentTrack $respTrack, integer $userId) : integer
Inherited

Parameters

$respTrack

\Gems_Tracker_RespondentTrack

The respondent track to check

$userId

integer

Id of the user who takes the action (for logging)

Returns

integerThe number of tokens changed by this code

The logic to set the display of the valid_X_field date list field.

setDateListFor(\MUtil_Model_ModelAbstract $model, string $fieldName, string $source, integer $roundId, string $language, boolean $validAfter) 
Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

The round model

$fieldName

string

The valid_X_field to set

$source

string

The date list source as defined by this object

$roundId

integer

Optional a round id

$language

string

(ISO) language string

$validAfter

boolean

True if it concerns _valid_after_ dates

Update the track, both in the database and in memory.

_update(array $values, integer $userId) : integer
Inherited

Parameters

$values

array

The values that this token should be set to

$userId

integer

The current user

Returns

integer1 if data changed, 0 otherwise

 Properties

 

Stores how the fields are define for this track

$_fieldsDefinition : \Gems\Tracker\Engine\FieldsDefinition;

Default

 

Class name for creating the round model.

$_roundModelClass : string

Default

'MUtil_Model_TableModel'
 

of rounds objects, initiated at need

$_roundObjects : array

Default

 

of rounds data

$_rounds : array

Default

 

$_trackData

$_trackData : array

Default

 

$_trackId

$_trackId : integer

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$events

$events : \Gems_Events

Default

 

$loader

$loader : \Gems_Loader

Default

 

$locale

$locale : \Zend_Locale

Default

 

$project

$project : \Gems_Project_ProjectSettings

Default

 

$tracker

$tracker : \Gems_Tracker

Default

 

$util

$util : \Gems_Util

Default

 

$view

$view : \Zend_View

Default

 Constants

 

Database stored constant value for using an answer in a survey as date source

ANSWER_TABLE = 'ans' 
 

Database stored constant value for using an appointment as date source

APPOINTMENT_TABLE = 'app' 
 

Database stored constant value for using nothing as a date source

NO_TABLE = 'nul' 
 

Database stored constant value for using a track field as date source

RESPONDENT_TRACK_TABLE = 'rtr' 
 

Database stored constant value for using a token as date source

TOKEN_TABLE = 'tok'