easyappointments/application/models/Customers_model.php

383 lines
12 KiB
PHP
Raw Normal View History

<?php defined('BASEPATH') or exit('No direct script access allowed');
/* ----------------------------------------------------------------------------
* Easy!Appointments - Open Source Web Scheduler
*
* @package EasyAppointments
* @author A.Tselegidis <alextselegidis@gmail.com>
* @copyright Copyright (c) 2013 - 2020, Alex Tselegidis
* @license http://opensource.org/licenses/GPL-3.0 - GPLv3
* @link http://easyappointments.org
* @since v1.0.0
* ---------------------------------------------------------------------------- */
/**
* Customers Model
*
2020-09-23 12:47:18 +03:00
* @property CI_DB_query_builder $db
* @property CI_Loader $load
*
* @package Models
*/
class Customers_Model extends CI_Model {
/**
* Add a customer record to the database.
*
2017-09-08 15:03:45 +03:00
* This method adds a customer to the database. If the customer doesn't exists it is going to be inserted, otherwise
* the record is going to be updated.
*
* @param array $customer Associative array with the customer's data. Each key has the same name with the database
* fields.
*
* @return int Returns the customer id.
* @throws Exception
*/
public function add($customer)
{
// Validate the customer data before doing anything.
$this->validate($customer);
// :: CHECK IF CUSTOMER ALREADY EXIST (FROM EMAIL).
if ($this->exists($customer) && ! isset($customer['id']))
{
// Find the customer id from the database.
$customer['id'] = $this->find_record_id($customer);
}
// :: INSERT OR UPDATE CUSTOMER RECORD
if ( ! isset($customer['id']))
{
$customer['id'] = $this->insert($customer);
2018-01-23 12:08:37 +03:00
}
else
{
$this->update($customer);
}
return $customer['id'];
}
/**
* Validate customer data before the insert or update operation is executed.
2017-09-08 15:03:45 +03:00
*
* @param array $customer Contains the customer data.
*
* @return bool Returns the validation result.
2017-09-08 15:03:45 +03:00
*
* @throws Exception If customer validation fails.
*/
public function validate($customer)
{
$this->load->helper('data_validation');
// If a customer id is provided, check whether the record
// exist in the database.
if (isset($customer['id']))
{
$num_rows = $this->db->get_where('users',
['id' => $customer['id']])->num_rows();
if ($num_rows == 0)
{
throw new Exception('Provided customer id does not '
. 'exist in the database.');
}
}
$query = $this->db->get_where('settings', ['name' => 'require_phone_number']);
$phone_number_required = $query->num_rows() > 0 ? $query->row() === '1' : FALSE;
// Validate required fields
if (empty($customer['first_name'])
|| empty($customer['last_name'])
|| empty($customer['email'])
|| (empty($customer['phone_number']) && $phone_number_required))
{
throw new Exception('Not all required fields are provided: '
. print_r($customer, TRUE));
}
// Validate email address
if ( ! filter_var($customer['email'], FILTER_VALIDATE_EMAIL))
{
throw new Exception('Invalid email address provided: '
. $customer['email']);
}
// When inserting a record the email address must be unique.
$customer_id = (isset($customer['id'])) ? $customer['id'] : '';
$num_rows = $this->db
->select('*')
->from('users')
->join('roles', 'roles.id = users.id_roles', 'inner')
->where('roles.slug', DB_SLUG_CUSTOMER)
->where('users.email', $customer['email'])
->where('users.id <>', $customer_id)
->get()
->num_rows();
if ($num_rows > 0)
{
throw new Exception('Given email address belongs to another customer record. '
. 'Please use a different email.');
}
return TRUE;
}
/**
* Check if a particular customer record already exists.
*
* This method checks whether the given customer already exists in the database. It doesn't search with the id, but
* with the following fields: "email"
*
2017-09-08 15:03:45 +03:00
* @param array $customer Associative array with the customer's data. Each key has the same name with the database
* fields.
*
* @return bool Returns whether the record exists or not.
2017-09-08 15:03:45 +03:00
*
* @throws Exception If customer email property is missing.
*/
public function exists($customer)
{
if (empty($customer['email']))
{
throw new Exception('Customer\'s email is not provided.');
}
// This method shouldn't depend on another method of this class.
$num_rows = $this->db
->select('*')
->from('users')
->join('roles', 'roles.id = users.id_roles', 'inner')
->where('users.email', $customer['email'])
->where('roles.slug', DB_SLUG_CUSTOMER)
->get()->num_rows();
return ($num_rows > 0) ? TRUE : FALSE;
}
/**
* Find the database id of a customer record.
*
2017-09-08 15:03:45 +03:00
* The customer data should include the following fields in order to get the unique id from the database: "email"
*
* IMPORTANT: The record must already exists in the database, otherwise an exception is raised.
*
* @param array $customer Array with the customer data. The keys of the array should have the same names as the
* database fields.
*
2017-09-08 15:03:45 +03:00
* @return int Returns the ID.
*
2017-09-08 15:03:45 +03:00
* @throws Exception If customer record does not exist.
*/
public function find_record_id($customer)
{
if (empty($customer['email']))
{
throw new Exception('Customer\'s email was not provided: '
. print_r($customer, TRUE));
}
// Get customer's role id
$result = $this->db
->select('users.id')
->from('users')
->join('roles', 'roles.id = users.id_roles', 'inner')
->where('users.email', $customer['email'])
->where('roles.slug', DB_SLUG_CUSTOMER)
->get();
if ($result->num_rows() == 0)
{
throw new Exception('Could not find customer record id.');
}
return $result->row()->id;
}
/**
* Insert a new customer record to the database.
*
* @param array $customer Associative array with the customer's data. Each key has the same name with the database
* fields.
2017-09-08 15:03:45 +03:00
*
* @return int Returns the id of the new record.
2017-09-08 15:03:45 +03:00
*
* @throws Exception If customer record could not be inserted.
*/
protected function insert($customer)
{
// Before inserting the customer we need to get the customer's role id
// from the database and assign it to the new record as a foreign key.
$customer_role_id = $this->db
->select('id')
->from('roles')
->where('slug', DB_SLUG_CUSTOMER)
->get()->row()->id;
$customer['id_roles'] = $customer_role_id;
if ( ! $this->db->insert('users', $customer))
{
throw new Exception('Could not insert customer to the database.');
}
return (int)$this->db->insert_id();
}
/**
* Update an existing customer record in the database.
*
* The customer data argument should already include the record ID in order to process the update operation.
*
* @param array $customer Associative array with the customer's data. Each key has the same name with the database
* fields.
*
* @return int Returns the updated record ID.
*
* @throws Exception If customer record could not be updated.
*/
protected function update($customer)
{
$this->db->where('id', $customer['id']);
if ( ! $this->db->update('users', $customer))
{
throw new Exception('Could not update customer to the database.');
}
return (int)$customer['id'];
}
/**
* Delete an existing customer record from the database.
*
2017-09-08 15:03:45 +03:00
* @param int $customer_id The record id to be deleted.
*
* @return bool Returns the delete operation result.
2017-09-08 15:03:45 +03:00
*
* @throws Exception If $customer_id argument is invalid.
*/
public function delete($customer_id)
{
if ( ! is_numeric($customer_id))
{
throw new Exception('Invalid argument type $customer_id: ' . $customer_id);
}
$num_rows = $this->db->get_where('users', ['id' => $customer_id])->num_rows();
if ($num_rows == 0)
{
return FALSE;
}
return $this->db->delete('users', ['id' => $customer_id]);
}
/**
* Get a specific row from the appointments table.
*
2017-09-08 15:03:45 +03:00
* @param int $customer_id The record's id to be returned.
*
* @return array Returns an associative array with the selected record's data. Each key has the same name as the
* database field names.
*
* @throws Exception If $customer_id argumnet is invalid.
*/
public function get_row($customer_id)
{
if ( ! is_numeric($customer_id))
{
throw new Exception('Invalid argument provided as $customer_id : ' . $customer_id);
}
return $this->db->get_where('users', ['id' => $customer_id])->row_array();
}
/**
* Get a specific field value from the database.
*
2017-09-08 15:03:45 +03:00
* @param string $field_name The field name of the value to be returned.
* @param int $customer_id The selected record's id.
2017-09-08 15:03:45 +03:00
*
* @return string Returns the records value from the database.
2017-09-08 15:03:45 +03:00
*
* @throws Exception If $customer_id argument is invalid.
* @throws Exception If $field_name argument is invalid.
* @throws Exception If requested customer record does not exist in the database.
* @throws Exception If requested field name does not exist in the database.
*/
public function get_value($field_name, $customer_id)
{
if ( ! is_numeric($customer_id))
{
throw new Exception('Invalid argument provided as $customer_id: '
. $customer_id);
}
if ( ! is_string($field_name))
{
throw new Exception('$field_name argument is not a string: '
. $field_name);
}
if ($this->db->get_where('users', ['id' => $customer_id])->num_rows() == 0)
{
throw new Exception('The record with the $customer_id argument '
. 'does not exist in the database: ' . $customer_id);
}
$row_data = $this->db->get_where('users', ['id' => $customer_id]
)->row_array();
if ( ! isset($row_data[$field_name]))
{
throw new Exception('The given $field_name argument does not'
. 'exist in the database: ' . $field_name);
}
$customer = $this->db->get_where('users', ['id' => $customer_id])->row_array();
return $customer[$field_name];
}
/**
* Get all, or specific records from appointment's table.
*
* Example:
*
* $this->Model->getBatch('id = ' . $recordId);
2017-09-08 15:03:45 +03:00
*
* @param mixed|null $where
* @param midex|null $order_by
* @param int|null $limit
* @param int|null $offset
* @return array Returns the rows from the database.
*/
public function get_batch($where = NULL, $order_by = NULL, $limit = NULL, $offset = NULL)
{
2020-04-08 11:31:01 +03:00
$role_id = $this->get_customers_role_id();
if ($where !== NULL)
{
$this->db->where($where);
}
if ($order_by !== NULL)
{
$this->db->order_by($order_by);
}
return $this->db->get_where('users', ['id_roles' => $role_id], $limit, $offset)->result_array();
}
/**
* Get the customers role id from the database.
*
* @return int Returns the role id for the customer records.
*/
public function get_customers_role_id()
{
return $this->db->get_where('roles', ['slug' => DB_SLUG_CUSTOMER])->row()->id;
}
}