GemsTracker library API
Back to top  

package Gems
subpackage Agenda
copyright Copyright (c) 2014 Erasmus MC
license New BSD License
since Class available since version 1.6.3

 Methods

Creates the appointments object

__construct(mixed $appointmentData) 

Parameters

$appointmentData

mixed

Appointment Id or array containing appointment record

Should be called after answering the request to allow the Target to check if all required registry values have been set correctly.

checkRegistryRequestsAnswers() : boolean

Returns

booleanFalse if required are missing.

Return the description of the current ativity

getActivityDescription() : string

Returns

stringor null when not found

Return the id of the current activity

getActivityId() : integer

Returns

integer

Return the admission time

getAdmissionTime() : \MUtil_Date

Returns

\MUtil_DateAdmission time as a date or null

Get the DB id of the attending by person

getAttendedById() : integer

Returns

integer

The cooment to the appointment

getComment() : string

Returns

string

Get a general description of this appointment

getDisplayString() : string
see

Returns

string

Return the appointment id

getId() : integer

Returns

integer

Return the description of the current location

getLocationDescription() : string

Returns

stringor null when not found

Get the DB id of the location

getLocationId() : integer

Returns

integer

getOrganizationId() 

getOrganizationId() : integer

Returns

integer

getPatientNumber() 

getPatientNumber() : string

Returns

stringThe respondents patient number

Return the description of the current procedure

getProcedureDescription() : string

Returns

stringor null when not found

Return the id of the current procedure

getProcedureId() : integer

Returns

integer

Get the DB id of the referred by person

getReferredById() : integer

Returns

integer

Return the respondent object

getRespondent() : \Gems_Tracker_Respondent

Returns

\Gems_Tracker_Respondent

Return the user / respondent id

getRespondentId() : integer

Returns

integer

The source of the appointment

getSource() : string

Returns

string

The source id of the appointment

getSourceId() : string

Returns

string

The subject of the appointment

getSubject() : string

Returns

string

Return true when the satus is active

isActive() : \type

Returns

\type

refresh() 

refresh(array $gemsData = null) : \Gems_Agenda_Appointment

Parameters

$gemsData

array

Optional, the data refresh with, otherwise refresh from database.

Returns

\Gems_Agenda_Appointment(continuation pattern)

Recalculate all tracks that use this appointment

updateTracks() : integer

Returns

integerThe number of tokens changed by this code

Makes sure the respondent data is part of the $this->_gemsData

_ensureRespondentOrgData() 

 Properties

 

True when the token does exist.

$exists : boolean

Default

true
 

The id of the appointment

$_appointmentId : integer

Default

 

The gems appointment data

$_gemsData : array

Default

array()
 

$agenda

$agenda : \Gems_Agenda

Default

 

$currentUser

$currentUser : \Gems_User_User

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$loader

$loader : \Gems_Loader

Default