API Documentation
\

\Appointments_Model

Summary

Methods
Properties
Constants
__construct()
add()
exists()
find_record_id()
validate()
delete()
get_row()
get_value()
get_batch()
generate_hash()
add_unavailable()
delete_unavailable()
clear_google_sync_ids()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
insert()
update()
No private properties found
N/A

Methods

__construct()

__construct()

Class Constructor

add()

add(array  $appointment) : integer

Add an appointment record to the database.

This method adds a new appointment to the database. If the appointment doesn't exists it is going to be inserted, otherwise the record is going to be updated.

Parameters

array $appointment

Associative array with the appointment data. Each key has the same name with the database fields.

Returns

integer —

Returns the appointments id.

exists()

exists(array  $appointment) : boolean

Check if a particular appointment record already exists.

This method checks wether the given appointment already exists in the database. It doesn't search with the id, but by using the following fields: "start_datetime", "end_datetime", "id_users_provider", "id_users_customer", "id_services".

Parameters

array $appointment

Associative array with the appointment's data. Each key has the same name with the database fields.

Returns

boolean —

Returns wether the record exists or not.

find_record_id()

find_record_id(array  $appointment) : integer

Find the database id of an appointment record.

The appointment data should include the following fields in order to get the unique id from the database: "start_datetime", "end_datetime", "id_users_provider", "id_users_customer", "id_services".

IMPORTANT! The record must already exists in the database, otherwise an exception is raised.

Parameters

array $appointment

Array with the appointment data. The keys of the array should have the same names as the db fields.

Returns

integer —

Returns the db id of the record that matches the apppointment data.

validate()

validate(array  $appointment) : boolean

Validate appointment data before the insert or update operations are executed.

Parameters

array $appointment

Contains the appointment data.

Returns

boolean —

Returns the validation result.

delete()

delete(\numeric  $appointment_id) : boolean

Delete an existing appointment record from the database.

Parameters

\numeric $appointment_id

The record id to be deleted.

Returns

boolean —

Returns the delete operation result.

get_row()

get_row(\numeric  $appointment_id) : array

Get a specific row from the appointments table.

Parameters

\numeric $appointment_id

The record's id to be returned.

Returns

array —

Returns an associative array with the selected record's data. Each key has the same name as the database field names.

get_value()

get_value(string  $field_name, \numeric  $appointment_id) : string

Get a specific field value from the database.

Parameters

string $field_name

The field name of the value to be returned.
\numeric $appointment_id

The selected record's id.

Returns

string —

Returns the records value from the database.

get_batch()

get_batch(string  $where_clause = '') : array

Get all, or specific records from appointment's table.

Parameters

string $where_clause

(OPTIONAL) The WHERE clause of the query to be executed. DO NOT INCLUDE 'WHERE' KEYWORD.

Returns

array —

Returns the rows from the database.

Examples

= ' . $recordId);
** File not found : $this->Model->getBatch('id **

generate_hash()

generate_hash() : string

Generate a unique hash for the given appointment data.

This method uses the current date-time to generate a unique hash string that is later used to identify this appointment. Hash is needed when the email is send to the user with an edit link.

Returns

string —

Returns the unique appointment hash.

add_unavailable()

add_unavailable(array  $unavailable) : integer

Inserts or updates an unavailable period record in the database.

Parameters

array $unavailable

Contains the unavaible data.

Returns

integer —

Returns the record id.

delete_unavailable()

delete_unavailable(\numeric  $unavailable_id)

Delete an unavailable period.

Parameters

\numeric $unavailable_id

Record id to be deleted.

clear_google_sync_ids()

clear_google_sync_ids(\numeric  $provider_id)

Clear google sync IDs from appointment record.

Parameters

\numeric $provider_id

The appointment provider record id.

insert()

insert(array  $appointment) : integer

Insert a new appointment record to the database.

Parameters

array $appointment

Associative array with the appointment's data. Each key has the same name with the database fields.

Returns

integer —

Returns the id of the new record.

update()

update(array  $appointment)

Update an existing appointment record in the database.

The appointment data argument should already include the record id in order to process the update operation.

Parameters

array $appointment

Associative array with the appointment's data. Each key has the same name with the database fields.