542 lines
17 KiB
PHP
542 lines
17 KiB
PHP
<?php defined('BASEPATH') or exit('No direct script access allowed');
|
||
|
||
/* ----------------------------------------------------------------------------
|
||
* MaketRandevu - MAKET Randevu Portalı
|
||
*
|
||
* @package EasyAppointments
|
||
* @author A.Tselegidis <alextselegidis@gmail.com>
|
||
* @copyright Copyright (c) Alex Tselegidis
|
||
* @license https://opensource.org/licenses/GPL-3.0 - GPLv3
|
||
* @link https://easyappointments.org
|
||
* @since v1.0.0
|
||
* ---------------------------------------------------------------------------- */
|
||
|
||
/**
|
||
* Customers model.
|
||
*
|
||
* Handles all the database operations of the customer resource.
|
||
*
|
||
* @package Models
|
||
*/
|
||
class Customers_model extends EA_Model
|
||
{
|
||
/**
|
||
* @var array
|
||
*/
|
||
protected array $casts = [
|
||
'id' => 'integer',
|
||
'id_roles' => 'integer',
|
||
];
|
||
|
||
/**
|
||
* @var array
|
||
*/
|
||
protected array $api_resource = [
|
||
'id' => 'id',
|
||
'firstName' => 'first_name',
|
||
'lastName' => 'last_name',
|
||
'email' => 'email',
|
||
'phone' => 'phone_number',
|
||
'address' => 'address',
|
||
'city' => 'city',
|
||
'state' => 'state',
|
||
'zip' => 'zip_code',
|
||
'timezone' => 'timezone',
|
||
'language' => 'language',
|
||
'customField1' => 'custom_field_1',
|
||
'customField2' => 'custom_field_2',
|
||
'customField3' => 'custom_field_3',
|
||
'customField4' => 'custom_field_4',
|
||
'customField5' => 'custom_field_5',
|
||
'notes' => 'notes',
|
||
];
|
||
|
||
/**
|
||
* Save (insert or update) a customer.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
*
|
||
* @return int Returns the customer ID.
|
||
*
|
||
* @throws InvalidArgumentException
|
||
*/
|
||
public function save(array $customer): int
|
||
{
|
||
$this->validate($customer);
|
||
|
||
if ($this->exists($customer) && empty($customer['id'])) {
|
||
$customer['id'] = $this->find_record_id($customer);
|
||
}
|
||
|
||
if (empty($customer['id'])) {
|
||
return $this->insert($customer);
|
||
} else {
|
||
return $this->update($customer);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Validate the customer data.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
*
|
||
* @throws InvalidArgumentException
|
||
*/
|
||
public function validate(array $customer)
|
||
{
|
||
// If a customer ID is provided then check whether the record really exists in the database.
|
||
if (!empty($customer['id'])) {
|
||
$count = $this->db->get_where('users', ['id' => $customer['id']])->num_rows();
|
||
|
||
if (!$count) {
|
||
throw new InvalidArgumentException(
|
||
'The provided customer ID does not exist in the database: ' . $customer['id'],
|
||
);
|
||
}
|
||
}
|
||
|
||
// Make sure all required fields are provided.
|
||
$require_first_name = filter_var(setting('require_phone_number'), FILTER_VALIDATE_BOOLEAN);
|
||
$require_last_name = filter_var(setting('require_last'), FILTER_VALIDATE_BOOLEAN);
|
||
$require_email = filter_var(setting('require_email'), FILTER_VALIDATE_BOOLEAN);
|
||
$require_phone_number = filter_var(setting('require_phone_number'), FILTER_VALIDATE_BOOLEAN);
|
||
$require_address = filter_var(setting('require_address'), FILTER_VALIDATE_BOOLEAN);
|
||
$require_city = filter_var(setting('require_city'), FILTER_VALIDATE_BOOLEAN);
|
||
$require_zip_code = filter_var(setting('require_zip_code'), FILTER_VALIDATE_BOOLEAN);
|
||
|
||
if (
|
||
(empty($customer['first_name']) && $require_first_name) ||
|
||
(empty($customer['last_name']) && $require_last_name) ||
|
||
(empty($customer['email']) && $require_email) ||
|
||
(empty($customer['phone_number']) && $require_phone_number) ||
|
||
(empty($customer['address']) && $require_address) ||
|
||
(empty($customer['city']) && $require_city) ||
|
||
(empty($customer['zip_code']) && $require_zip_code)
|
||
) {
|
||
throw new InvalidArgumentException('Not all required fields are provided: ' . print_r($customer, true));
|
||
}
|
||
|
||
if (!empty($customer['email'])) {
|
||
// Validate the email address.
|
||
if (!filter_var($customer['email'], FILTER_VALIDATE_EMAIL)) {
|
||
throw new InvalidArgumentException('Invalid email address provided: ' . $customer['email']);
|
||
}
|
||
|
||
// Make sure the email address is unique.
|
||
$customer_id = $customer['id'] ?? null;
|
||
|
||
$count = $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 ($count > 0) {
|
||
throw new InvalidArgumentException(
|
||
'The provided email address is already in use, please use a different one.',
|
||
);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Get all customers that match the provided criteria.
|
||
*
|
||
* @param array|string|null $where Where conditions.
|
||
* @param int|null $limit Record limit.
|
||
* @param int|null $offset Record offset.
|
||
* @param string|null $order_by Order by.
|
||
*
|
||
* @return array Returns an array of customers.
|
||
*/
|
||
public function get(
|
||
array|string $where = null,
|
||
int $limit = null,
|
||
int $offset = null,
|
||
string $order_by = null,
|
||
): array {
|
||
$role_id = $this->get_customer_role_id();
|
||
|
||
if ($where !== null) {
|
||
$this->db->where($where);
|
||
}
|
||
|
||
if ($order_by !== null) {
|
||
$this->db->order_by($order_by);
|
||
}
|
||
|
||
$customers = $this->db->get_where('users', ['id_roles' => $role_id], $limit, $offset)->result_array();
|
||
|
||
foreach ($customers as &$customer) {
|
||
$this->cast($customer);
|
||
}
|
||
|
||
return $customers;
|
||
}
|
||
|
||
/**
|
||
* Get the customer role ID.
|
||
*
|
||
* @return int Returns the role ID.
|
||
*/
|
||
public function get_customer_role_id(): int
|
||
{
|
||
$role = $this->db->get_where('roles', ['slug' => DB_SLUG_CUSTOMER])->row_array();
|
||
|
||
if (empty($role)) {
|
||
throw new RuntimeException('The customer role was not found in the database.');
|
||
}
|
||
|
||
return $role['id'];
|
||
}
|
||
|
||
/**
|
||
* Check if a particular customer record already exists in the database.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
*
|
||
* @return bool Returns whether there is a record matching the provided one or not.
|
||
*
|
||
* @throws InvalidArgumentException
|
||
*/
|
||
public function exists(array $customer): bool
|
||
{
|
||
if (empty($customer['email'])) {
|
||
return false;
|
||
}
|
||
|
||
$count = $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 $count > 0;
|
||
}
|
||
|
||
/**
|
||
* Find the record ID of a customer.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
*
|
||
* @return int Returns the ID of the record that matches the provided argument.
|
||
*
|
||
* @throws InvalidArgumentException
|
||
*/
|
||
public function find_record_id(array $customer): int
|
||
{
|
||
if (empty($customer['email'])) {
|
||
throw new InvalidArgumentException('The customer email was not provided: ' . print_r($customer, true));
|
||
}
|
||
|
||
$customer = $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()
|
||
->row_array();
|
||
|
||
if (empty($customer)) {
|
||
throw new InvalidArgumentException('Could not find customer record id.');
|
||
}
|
||
|
||
return (int) $customer['id'];
|
||
}
|
||
|
||
/**
|
||
* Insert a new customer into the database.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
*
|
||
* @return int Returns the customer ID.
|
||
*
|
||
* @throws RuntimeException
|
||
*/
|
||
protected function insert(array $customer): int
|
||
{
|
||
$customer['create_datetime'] = date('Y-m-d H:i:s');
|
||
$customer['update_datetime'] = date('Y-m-d H:i:s');
|
||
$customer['id_roles'] = $this->get_customer_role_id();
|
||
|
||
if (!$this->db->insert('users', $customer)) {
|
||
throw new RuntimeException('Could not insert customer.');
|
||
}
|
||
|
||
return $this->db->insert_id();
|
||
}
|
||
|
||
/**
|
||
* Update an existing customer.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
*
|
||
* @return int Returns the customer ID.
|
||
*
|
||
* @throws RuntimeException
|
||
*/
|
||
protected function update(array $customer): int
|
||
{
|
||
$customer['update_datetime'] = date('Y-m-d H:i:s');
|
||
|
||
if (!$this->db->update('users', $customer, ['id' => $customer['id']])) {
|
||
throw new RuntimeException('Could not update customer.');
|
||
}
|
||
|
||
return $customer['id'];
|
||
}
|
||
|
||
/**
|
||
* Remove an existing customer from the database.
|
||
*
|
||
* @param int $customer_id Customer ID.
|
||
*
|
||
* @throws RuntimeException
|
||
*/
|
||
public function delete(int $customer_id): void
|
||
{
|
||
$this->db->delete('users', ['id' => $customer_id]);
|
||
}
|
||
|
||
/**
|
||
* Get a specific customer from the database.
|
||
*
|
||
* @param int $customer_id The ID of the record to be returned.
|
||
*
|
||
* @return array Returns an array with the customer data.
|
||
*/
|
||
public function find(int $customer_id): array
|
||
{
|
||
$customer = $this->db->get_where('users', ['id' => $customer_id])->row_array();
|
||
|
||
if (!$customer) {
|
||
throw new InvalidArgumentException(
|
||
'The provided customer ID was not found in the database: ' . $customer_id,
|
||
);
|
||
}
|
||
|
||
$this->cast($customer);
|
||
|
||
return $customer;
|
||
}
|
||
|
||
/**
|
||
* Get a specific field value from the database.
|
||
*
|
||
* @param int $customer_id Customer ID.
|
||
* @param string $field Name of the value to be returned.
|
||
*
|
||
* @return mixed Returns the selected customer value from the database.
|
||
*
|
||
* @throws InvalidArgumentException
|
||
*/
|
||
public function value(int $customer_id, string $field): mixed
|
||
{
|
||
if (empty($field)) {
|
||
throw new InvalidArgumentException('The field argument is cannot be empty.');
|
||
}
|
||
|
||
if (empty($customer_id)) {
|
||
throw new InvalidArgumentException('The customer ID argument cannot be empty.');
|
||
}
|
||
|
||
// Check whether the customer exists.
|
||
$query = $this->db->get_where('users', ['id' => $customer_id]);
|
||
|
||
if (!$query->num_rows()) {
|
||
throw new InvalidArgumentException(
|
||
'The provided customer ID was not found in the database: ' . $customer_id,
|
||
);
|
||
}
|
||
|
||
// Check if the required field is part of the customer data.
|
||
$customer = $query->row_array();
|
||
|
||
$this->cast($customer);
|
||
|
||
if (!array_key_exists($field, $customer)) {
|
||
throw new InvalidArgumentException('The requested field was not found in the customer data: ' . $field);
|
||
}
|
||
|
||
return $customer[$field];
|
||
}
|
||
|
||
/**
|
||
* Get the query builder interface, configured for use with the users (customer-filtered) table.
|
||
*
|
||
* @return CI_DB_query_builder
|
||
*/
|
||
public function query(): CI_DB_query_builder
|
||
{
|
||
$role_id = $this->get_customer_role_id();
|
||
|
||
return $this->db->from('users')->where('id_roles', $role_id);
|
||
}
|
||
|
||
/**
|
||
* Search customers by the provided keyword.
|
||
*
|
||
* @param string $keyword Search keyword.
|
||
* @param int|null $limit Record limit.
|
||
* @param int|null $offset Record offset.
|
||
* @param string|null $order_by Order by.
|
||
*
|
||
* @return array Returns an array of customers.
|
||
*/
|
||
public function search(string $keyword, int $limit = null, int $offset = null, string $order_by = null): array
|
||
{
|
||
$role_id = $this->get_customer_role_id();
|
||
|
||
$customers = $this->db
|
||
->select()
|
||
->from('users')
|
||
->where('id_roles', $role_id)
|
||
->group_start()
|
||
->like('first_name', $keyword)
|
||
->or_like('last_name', $keyword)
|
||
->or_like('CONCAT_WS(" ", first_name, last_name)', $keyword)
|
||
->or_like('email', $keyword)
|
||
->or_like('phone_number', $keyword)
|
||
->or_like('mobile_number', $keyword)
|
||
->or_like('address', $keyword)
|
||
->or_like('city', $keyword)
|
||
->or_like('state', $keyword)
|
||
->or_like('zip_code', $keyword)
|
||
->or_like('notes', $keyword)
|
||
->group_end()
|
||
->limit($limit)
|
||
->offset($offset)
|
||
->order_by($order_by)
|
||
->get()
|
||
->result_array();
|
||
|
||
foreach ($customers as &$customer) {
|
||
$this->cast($customer);
|
||
}
|
||
|
||
return $customers;
|
||
}
|
||
|
||
/**
|
||
* Load related resources to a customer.
|
||
*
|
||
* @param array $customer Associative array with the customer data.
|
||
* @param array $resources Resource names to be attached.
|
||
*
|
||
* @throws InvalidArgumentException
|
||
*/
|
||
public function load(array &$customer, array $resources)
|
||
{
|
||
// Customers do not currently have any related resources.
|
||
}
|
||
|
||
/**
|
||
* Convert the database customer record to the equivalent API resource.
|
||
*
|
||
* @param array $customer Customer data.
|
||
*/
|
||
public function api_encode(array &$customer)
|
||
{
|
||
$encoded_resource = [
|
||
'id' => array_key_exists('id', $customer) ? (int) $customer['id'] : null,
|
||
'firstName' => $customer['first_name'],
|
||
'lastName' => $customer['last_name'],
|
||
'email' => $customer['email'],
|
||
'phone' => $customer['phone_number'],
|
||
'address' => $customer['address'],
|
||
'city' => $customer['city'],
|
||
'zip' => $customer['zip_code'],
|
||
'notes' => $customer['notes'],
|
||
'timezone' => $customer['timezone'],
|
||
'customField1' => $customer['custom_field_1'],
|
||
'customField2' => $customer['custom_field_2'],
|
||
'customField3' => $customer['custom_field_3'],
|
||
'customField4' => $customer['custom_field_4'],
|
||
'customField5' => $customer['custom_field_5'],
|
||
];
|
||
|
||
$customer = $encoded_resource;
|
||
}
|
||
|
||
/**
|
||
* Convert the API resource to the equivalent database admin record.
|
||
*
|
||
* @param array $customer API resource.
|
||
* @param array|null $base Base customer data to be overwritten with the provided values (useful for updates).
|
||
*/
|
||
public function api_decode(array &$customer, array $base = null)
|
||
{
|
||
$decoded_resource = $base ?: [];
|
||
|
||
if (array_key_exists('id', $customer)) {
|
||
$decoded_resource['id'] = $customer['id'];
|
||
}
|
||
|
||
if (array_key_exists('firstName', $customer)) {
|
||
$decoded_resource['first_name'] = $customer['firstName'];
|
||
}
|
||
|
||
if (array_key_exists('lastName', $customer)) {
|
||
$decoded_resource['last_name'] = $customer['lastName'];
|
||
}
|
||
|
||
if (array_key_exists('email', $customer)) {
|
||
$decoded_resource['email'] = $customer['email'];
|
||
}
|
||
|
||
if (array_key_exists('phone', $customer)) {
|
||
$decoded_resource['phone_number'] = $customer['phone'];
|
||
}
|
||
|
||
if (array_key_exists('address', $customer)) {
|
||
$decoded_resource['address'] = $customer['address'];
|
||
}
|
||
|
||
if (array_key_exists('city', $customer)) {
|
||
$decoded_resource['city'] = $customer['city'];
|
||
}
|
||
|
||
if (array_key_exists('zip', $customer)) {
|
||
$decoded_resource['zip_code'] = $customer['zip'];
|
||
}
|
||
|
||
if (array_key_exists('language', $customer)) {
|
||
$decoded_resource['language'] = $customer['language'];
|
||
}
|
||
|
||
if (array_key_exists('customField1', $customer)) {
|
||
$decoded_resource['custom_field_1'] = $customer['customField1'];
|
||
}
|
||
|
||
if (array_key_exists('customField2', $customer)) {
|
||
$decoded_resource['custom_field_2'] = $customer['customField2'];
|
||
}
|
||
|
||
if (array_key_exists('customField3', $customer)) {
|
||
$decoded_resource['custom_field_3'] = $customer['customField3'];
|
||
}
|
||
|
||
if (array_key_exists('customField4', $customer)) {
|
||
$decoded_resource['custom_field_4'] = $customer['customField4'];
|
||
}
|
||
|
||
if (array_key_exists('customField5', $customer)) {
|
||
$decoded_resource['custom_field_5'] = $customer['customField5'];
|
||
}
|
||
|
||
if (array_key_exists('notes', $customer)) {
|
||
$decoded_resource['notes'] = $customer['notes'];
|
||
}
|
||
|
||
$customer = $decoded_resource;
|
||
}
|
||
}
|