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.5 13-okt-2014 20:01:38
inherited_from \Gems\Agenda\AppointmentFilterAbstract

 Methods

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

afterRegistry() : void
Inherited

Load the object from a data array

exchangeArray(array $data) 
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::exchangeArray()

Parameters

$data

array

The appointment field id from gtap_id_app_field

getAppointmentFieldId() : integer
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getAppointmentFieldId()

Returns

integer

Get the field value from an appointment object

getAppointmentFieldVale(\Gems_Agenda_Appointment $appointment, string $field) : mixed

Parameters

$appointment

\Gems_Agenda_Appointment

$field

string

Returns

mixed

The field id as it is recognized be the track engine

getFieldId() : string
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getFieldId()

Returns

string

The filter id

getFilterId() : integer
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getFilterId()

Returns

integer

The name of the filter

getName() : string
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getName()

Returns

string

Generate a where statement to filter the appointment model

getSqlWhere() : string

Returns

string

The track field id for the filter

getTrackAppointmentFieldId() : integer
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getTrackAppointmentFieldId()

Returns

integer

The track id for the filter

getTrackId() : integer
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getTrackId()

Returns

integer

The number of days to wait between track creation

getWaitDays() : integer
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::getWaitDays()

Returns

integeror null when no track creation or no wait days

Should this track be created when it does not exist?

isCreator() : boolean
Inherited
inherited_from \Gems\Agenda\AppointmentFilterInterface::isCreator()

Returns

boolean

Check a filter for a match

matchAppointment(\Gems\Agenda\Gems_Agenda_Appointment $appointment) : boolean

Parameters

$appointment

\Gems\Agenda\Gems_Agenda_Appointment

Returns

boolean

By default only object variables starting with '_' are serialized in order to avoid serializing any resource types loaded by \MUtil_Translate_TranslateableAbstract

serialize() : string
Inherited

Returns

string

Restore parameter values

unserialize(string $data) 
Inherited

Parameters

$data

string

Override this function when you need to perform any actions when the data is loaded.

afterLoad() 

Test for the availability of variables as these objects can be loaded data first after deserialization or registry variables first after normal instantiation.

That is why this function called both at the end of afterRegistry() and after exchangeArray(), but NOT after unserialize().

After this the object should be ready for serialization

inherited_from \Gems\Agenda\AppointmentFilterAbstract::afterLoad()

Override this function when you need to perform any actions when the data is loaded.

afterLoad() 
Inherited

Test for the availability of variables as these objects can be loaded data first after deserialization or registry variables first after normal instantiation.

That is why this function called both at the end of afterRegistry() and after exchangeArray(), but NOT after unserialize().

After this the object should be ready for serialization

 Properties

 

Initial data settings

$_data : array

Default

 

id => id

$_fieldList2 : array

Default

 

id => id

$_fieldList4 : array

Default

 

List of lookup tables for linked values

$_lookupTables 

Default

array('gap_id_organization' => array('tableName' => 'gems__organizations', 'tableId' => 'gor_id_organization', 'tableLikeFilter' => "gor_active = 1 AND gor_name LIKE '%s'"), 'gap_id_attended_by' => array('tableName' => 'gems__agenda_staff', 'tableId' => 'gas_id_staff', 'tableLikeFilter' => "gas_active = 1 AND gas_name LIKE '%s'"), 'gap_id_referred_by' => array('tableName' => 'gems__agenda_staff', 'tableId' => 'gas_id_staff', 'tableLikeFilter' => "gas_active = 1 AND gas_name LIKE '%s'"), 'gap_id_activity' => array('tableName' => 'gems__agenda_activities', 'tableId' => 'gaa_id_activity', 'tableLikeFilter' => "gaa_active = 1 AND gaa_name LIKE '%s'"), 'gap_id_procedure' => array('tableName' => 'gems__agenda_procedures', 'tableId' => 'gapr_id_procedure', 'tableLikeFilter' => "gapr_active = 1 AND gapr_name LIKE '%s'"), 'gap_id_location' => array('tableName' => 'gems__locations', 'tableId' => 'glo_id_location', 'tableLikeFilter' => "glo_active = 1 AND glo_name LIKE '%s'"))
return fieldname => array(tableName, tableId, tableLikeFilter)
 

$agenda

$agenda : \Gems_Agenda

Default

 

$db

$db 

Default

 Constants

 

Constant for filters that should never trigger

NO_MATCH_SQL = '1=0'