The StandardTokenModel is the model used to display tokens in e.g. browse tables. It can also be used to edit standard tokens, though track engines may supply different models for editing, as the SingleSurveyTokeModel does.
The standard token model combines all possible information about the token from the tables:
The \MUtil_Registry_TargetInterface is implemented so that these models can take care of their own formatting.
see | |
---|---|
package | Gems |
subpackage | Tracker |
copyright | Copyright (c) 2011 Erasmus MC |
license | New BSD License |
since | Class available since version 1.4 |
inherited_from | \Gems_Model_HiddenOrganizationModel |
_(string $text, string|\Zend_Locale $locale = null
) : string
Translates the given string returns the translation
string
Translation string
string
\Zend_Locale
(optional) Locale/Language to use, identical with locale identifier, @see \Zend_Locale for more information
string
__construct()
__construct(string $name, string $startTable, string $fieldPrefix= null
, mixed $saveable= null
)
string
A name for the model
string
The base table for the model
string
Prefix to use for change fields (date/userid), if $saveable empty sets it to true
mixed
Will changes to this table be saved, true or a combination of SAVE_MODE constants
addEditTracking() : \Gems_Tracker_Model_StandardTokenModel
\Gems_Tracker_Model_StandardTokenModel
addLeftTable(mixed $table, array $joinFields, string $fieldPrefix= null
, mixed $saveable= null
) : \Gems_Model_JoinModel
mixed
The name of the table to join or a table object or an array(corr_name => tablename) or array(int => tablename, corr_name)
array
Array of source->dest primary keys for this join
string
Prefix to use for change fields (date/userid), if $saveable empty sets it to true
mixed
Will changes to this table be saved, true or a combination of SAVE_MODE constants
\Gems_Model_JoinModel
addRightTable(mixed $table, array $joinFields, string $fieldPrefix= null
, mixed $saveable= null
) : \Gems_Model_JoinModel
mixed
The name of the table to join or a table object or an array(corr_name => tablename) or array(int => tablename, corr_name)
array
Array of source->dest primary keys for this join
string
Prefix to use for change fields (date/userid), if $saveable empty sets it to true
mixed
Will changes to this table be saved, true or a combination of SAVE_MODE constants
\Gems_Model_JoinModel
addTable(mixed $table, array $joinFields, string $fieldPrefix= null
, mixed $saveable= null
) : \Gems_Model_JoinModel
mixed
The name of the table to join or a table object or an array(corr_name => tablename) or array(int => tablename, corr_name)
array
Array of source->dest primary keys for this join
string
Prefix to use for change fields (date/userid), if $saveable empty sets it to true
mixed
Will changes to this table be saved, true or a combination of SAVE_MODE constants
\Gems_Model_JoinModel
afterRegistry() : void
afterRegistry() : void
This function is no needed if the classes are setup correctly
applyFormatting() : \Gems_Tracker_Model_StandardTokenModel
..
\Gems_Tracker_Model_StandardTokenModel
applyInsertionFormatting() : \Gems_Tracker_Model_StandardTokenModel
..
\Gems_Tracker_Model_StandardTokenModel
applyParameters(array $parameters, boolean $includeNumericFilters = false
) : array
array
boolean
When true numeric filter keys (0, 1, 2...) are added to the filter as well
array
The $parameters minus the sort & textsearch keyscheckRegistryRequestsAnswers() : boolean
inherited_from | \Gems_Model_HiddenOrganizationModel::checkRegistryRequestsAnswers() |
---|
boolean
False if required are missing.checkRegistryRequestsAnswers() : boolean
boolean
False if required are missing.getCurrentOrganization() : integer
integer
getKeyRef(mixed $forData, array $href= array()
, $organizationInKey= null
) : array
basically transforms the fieldnames ointo oan IDn => value array
mixed
Array value to vilter on
array
Or \ArrayObject
array
That can by used as hrefplural(string $singular, string $plural, integer $number, string|\Zend_Locale $locale = null
) : string
Translates the given string using plural notations Returns the translated string
see |
---|
string
Singular translation string
string
Plural translation string
integer
Number for detecting the correct plural
string
\Zend_Locale
(Optional) Locale/Language to use, identical with locale identifier, @see \Zend_Locale for more information
string
saveCheckedMailDate(mixed $value, boolean $isNew= false
, string $name= null
, array $context= array()
) : boolean
saveCheckedMailNum(mixed $value, boolean $isNew= false
, string $name= null
, array $context= array()
) : boolean
setTableSaveable(string $table_name, string $fieldPrefix= null
, mixed $saveable= null
) : \Gems_Model_JoinModel
string
Does not test for existence
string
Prefix to use for change fields (date/userid), if $saveable empty sets it to true
mixed
Will changes to this table be saved, true or a combination of SAVE_MODE constants
\Gems_Model_JoinModel
useRespondentTrackAsKey()
useTokenAsKey()
_checkSaveable(mixed $saveable, string $fieldPrefix) : mixed
mixed
Will changes to this table be saved, true or a combination of SAVE_MODE constants
string
Prefix to use for change fields (date/userid), if $saveable empty sets it to true
mixed
The saveable setting to usegetTranslateAdapter() : \Zend_Translate_Adapter
\Zend_Translate_Adapter
initTranslateable()
This function is not needed if the variables have been defined correctly in the source for this object and theose variables have been applied.
return @void
_checkForMailSent(boolean $isNew, array $context) : boolean
boolean
True when a new item is being saved
array
The values being saved
boolean
True when the change should be triggered$currentUser : \Gems_User_User
$saveRespondentTracks : boolean
false
$translate : \Zend_Translate
$translateAdapter : \Zend_Translate_Adapter
$util : \Gems_Util