GemsTracker library API
Back to top  

Extends \MUtil_Registry_TargetAbstract with the ability to create PHP callables by request an existing method using $this->methodName.

package Gems
subpackage Tracker
copyright Copyright (c) 2013 Erasmus MC
license New BSD License
since Class available since version 1.6.2
inherited_from \Gems_Registry_TargetAbstract

 Methods

__construct() 

__construct(string $patientId, integer $organizationId, integer $respondentId = null) 

Parameters

$patientId

string

Patient number, you can use $respondentId instead

$organizationId

integer

Organization id

$respondentId

integer

Optional respondent id, used when patient id is empty

Returns a callable if a method is called as a variable

__get(string $name) : Callable
Inherited

Parameters

$name

string

Returns

Callable

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

afterRegistry() : void

Set menu parameters from this token

applyToMenuSource(\Gems_Menu_ParameterSource $source) : \Gems_Tracker_RespondentTrack

Parameters

$source

\Gems_Menu_ParameterSource

Returns

\Gems_Tracker_RespondentTrack(continuation pattern)

Creates a copy of the data data

getArrayCopy() : array

Returns

array

Get the birthdate

getBirthday() : \MUtil_Date | null

Returns

\MUtil_Datenull

Get the birthdate

getConsent() : \Gems\Util\ConsentCode

Returns

\Gems\Util\ConsentCode

Get Email adres of respondent

getEmailAddress() : string

Returns

string

Get First name of respondent

getFirstName() : string

Returns

string

Get the formal name of respondent

getFullName() : string

Returns

string

Get a single char code for the gender (normally M/F/U)

getGender() : string

Returns

string

Get the propper greeting of respondent

getGreeting() : string

Returns

string

Get the propper greeting of respondent

getGreetingNL() : string

Returns

string

getId() 

getId() : integer

Returns

integerThe respondent id

Get the respondents prefered language

getLanguage() : string

Returns

string

Get Last name of respondent

getLastName() : string

Returns

string

Get the full name (firstname, prefix and last name)

getName() : string

Returns

string

getOrganization() 

getOrganization() : \Gems_User_Organization

Returns

\Gems_User_Organization

getOrganizationId() 

getOrganizationId() : integer

Returns

integerOrganization ID

Get Patient number of respondent

getPatientId() : string
deprecated since version 1.6.4

Returns

string

getPatientNumber() 

getPatientNumber() : string

Returns

stringThe respondents patient number

Get the first entered phonenumber of the respondent.

getPhonenumber() : string

Returns

string

Return the \Gems_Util_ReceptionCode object

getReceptionCode() : \Gems_Util_ReceptionCode

Returns

\Gems_Util_ReceptionCodereception code

getRespondentModel() 

getRespondentModel() : \Gems_Model_RespondentModel

Returns

\Gems_Model_RespondentModel

Refresh the data

refresh() 

Restores tracks for a respondent, when the reception code matches the given $oldCode

restoreTracks(\Gems_Util_ReceptionCode $oldCode, \Gems_Util_ReceptionCode $newCode) : integer

Used when restoring a respondent, and the restore tracks box is checked. This will also restore all tokens in the tracks that have the same codes.

Parameters

$oldCode

\Gems_Util_ReceptionCode

The old reception code

$newCode

\Gems_Util_ReceptionCode

the new reception code

Returns

integerThe number of restored tracks

Overwrite the respondents prefered language

setLocale($locale) 

Parameters

$locale

Set the reception code for a respondent and cascade non-success codes to the tracks / surveys.

setReceptionCode(string $newCode) : \Gems_Util_ReceptionCode

Parameters

$newCode

string

String or \Gems_Util_ReceptionCode

Returns

\Gems_Util_ReceptionCodeThe new code reception code object for further processing

 Properties

 

true if Respondent exists in the database

$exists : Boolean

Default

false
 

The gems respondent and respondent to org data

$_gemsData : array

Default

 

Allow login info to be loaded

$addLoginCheck : boolean

Default

false
 

$currentUser

$currentUser : \Gems_User_User

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$loader

$loader : \Gems_Loader

Default

 

The highest grs_phone_nr phone number used in this project

$maxPhoneNumber : integer

Default

4
 

$model

$model : \Gems_Model_RespondentModel

Default

 

respondentId

$respondentId : integer

Default

 

Respondent language

$respondentLanguage : string

Default

 

$util

$util : \Gems_Util

Default

 

Organization Id

$organizationId : integer

Default

 

Patient Id

$patientId : string

Default