GemsTracker library API » \Gems_Util

Utility function for the use of reception codes.

package	Gems
subpackage	Util
copyright	Copyright (c) 2011 Erasmus MC
license	New BSD License
since	Class available since version 1.5
inherited_from	\Gems_Registry_CachedArrayTargetAbstract

Methods

Creates the object.

__construct(mixed $id)

Inherited

Parameters

$id

mixed

Whatever identifies this object.

Returns a callable if a method is called as a variable

__get(string $name) : Callable

Inherited

Parameters

$name

string

Returns

Callable

Compatibility mode, for use with logical operators returns this->getCode()

__toString() : string

Returns

string

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.

Returns the complete record.

getAllData() : array

Returns

array

The reception code.

getCode() : string

Returns

string

getDescription()

getDescription() : boolean

Returns

boolean

hasDescription()

hasDescription() : boolean

Returns

boolean

hasRedoCode()

hasRedoCode() : boolean

Returns

boolean

True if the reception code is a redo survey copy.

hasRedoCopyCode() : boolean

Returns

boolean

Empty the cache of the organization

invalidateCache() : \Gems_User_Organization

Inherited

Returns

\Gems_User_Organization(continutation pattern)

Is this code for respondent use?

isForRespondents() : boolean

Returns

boolean

Is this code for survey use?

isForSurveys() : boolean

Returns

boolean

Is this code for track use?

isForTracks() : boolean

Returns

boolean

Does this code overwrite set values?

isOverwriter() : boolean

Returns

boolean

Is this code a survey stop code.

isStopCode() : boolean

Then do not apply it to the track or respondent, but do apply it to the tokens.

Returns

boolean

Is this code a success code.

isSuccess() : boolean

Returns

boolean

isset() safe array access helper function.

_get(string $name) : mixed

Inherited

Parameters

$name

string

Returns

mixed

array access test helper function.

_has(string $name) : boolean

Inherited

Parameters

$name

string

Returns

boolean

Changes a value and signals the cache.

_set(string $name, mixed $value) : \Gems_Registry_CachedArrayTargetAbstract

Inherited

Parameters

$name

string

$value

mixed

Returns

\Gems_Registry_CachedArrayTargetAbstract(continuation pattern)

Load the data when the cache is empty.

loadData(mixed $id) : array

inherited_from	\Gems_Registry_CachedArrayTargetAbstract::loadData()

Parameters

$id

mixed

Returns

arrayThe array of data values

Load the data when the cache is empty.

loadData(mixed $id) : array

Inherited

Parameters

$id

mixed

Returns

arrayThe array of data values

Get the cacheId for the organization

_getCacheId() : string

Inherited

Returns

string

Properties

Does this data item exist?

$exists : boolean

Default

false

Variable to add tags to the cache for cleanup.

$_cacheTags : array

Default

array('receptionCode')

inherited_from	\Gems_Registry_CachedArrayTargetAbstract::_cacheTags

Variable to add tags to the cache for cleanup.

$_cacheTags : array

Default

array()

The current data.

$_data : array

Default

The id for this data

$_id : mixed

Default

$cache

$cache : \Zend_Cache_Core

Default

$db

$db : \Zend_Db_Adapter_Abstract

Default

Return false on checkRegistryRequestsAnswers when the anser is not an array

$requireArray : boolean

Default

true