easyappointments/application/models/Roles_model.php

392 lines
10 KiB
PHP
Raw Normal View History

<?php defined('BASEPATH') or exit('No direct script access allowed');
/* ----------------------------------------------------------------------------
2022-01-18 15:05:42 +03:00
* Easy!Appointments - Online Appointment Scheduler
*
* @package EasyAppointments
* @author A.Tselegidis <alextselegidis@gmail.com>
2021-12-18 19:43:45 +03:00
* @copyright Copyright (c) Alex Tselegidis
* @license https://opensource.org/licenses/GPL-3.0 - GPLv3
* @link https://easyappointments.org
* @since v1.0.0
* ---------------------------------------------------------------------------- */
/**
2021-11-06 18:21:27 +03:00
* Roles model.
2021-10-27 11:04:28 +03:00
*
* Handles all the database operations of the role resource.
*
* @package Models
*/
class Roles_model extends EA_Model {
2021-10-29 13:39:08 +03:00
/**
* @var array
*/
2023-03-13 11:06:18 +03:00
protected array $casts = [
2021-10-29 13:39:08 +03:00
'id' => 'integer',
'is_admin' => 'boolean',
'appointments' => 'integer',
'customers' => 'integer',
'services' => 'integer',
'users' => 'integer',
'system_settings' => 'integer',
'user_settings' => 'integer',
];
/**
2021-10-27 11:04:28 +03:00
* Save (insert or update) a role.
*
* @param array $role Associative array with the role data.
*
* @return int Returns the role ID.
*
* @throws InvalidArgumentException
*/
public function save(array $role): int
{
$this->validate($role);
if (empty($role['id']))
{
return $this->insert($role);
}
else
{
return $this->update($role);
}
}
/**
* Validate the role data.
*
2021-10-27 11:04:28 +03:00
* @param array $role Associative array with the role data.
2017-09-08 15:03:45 +03:00
*
2021-10-27 11:04:28 +03:00
* @throws InvalidArgumentException
*/
2021-10-27 11:49:42 +03:00
public function validate(array $role)
{
2021-10-27 11:04:28 +03:00
// If a role ID is provided then check whether the record really exists in the database.
if ( ! empty($role['id']))
{
$count = $this->db->get_where('roles', ['id' => $role['id']])->num_rows();
if ( ! $count)
{
throw new InvalidArgumentException('The provided role ID does not exist in the database: ' . $role['id']);
}
}
// Make sure all required fields are provided.
if (
empty($role['name'])
)
{
throw new InvalidArgumentException('Not all required fields are provided: ' . print_r($role, TRUE));
}
}
/**
* Insert a new role into the database.
*
* @param array $role Associative array with the role data.
*
* @return int Returns the role ID.
*
* @throws RuntimeException
*/
protected function insert(array $role): int
{
$role['create_datetime'] = date('Y-m-d H:i:s');
$role['update_datetime'] = date('Y-m-d H:i:s');
2021-10-27 11:04:28 +03:00
if ( ! $this->db->insert('roles', $role))
{
throw new RuntimeException('Could not insert role.');
}
return $this->db->insert_id();
}
/**
2021-10-27 11:04:28 +03:00
* Update an existing role.
*
2021-10-27 11:04:28 +03:00
* @param array $role Associative array with the role data.
*
2021-10-27 11:04:28 +03:00
* @return int Returns the role ID.
2017-09-08 15:03:45 +03:00
*
2021-10-27 11:04:28 +03:00
* @throws RuntimeException
*/
2021-10-27 11:04:28 +03:00
protected function update(array $role): int
{
$role['update_datetime'] = date('Y-m-d H:i:s');
2021-10-27 11:04:28 +03:00
if ( ! $this->db->update('roles', $role, ['id' => $role['id']]))
{
throw new RuntimeException('Could not update role.');
}
2021-10-27 11:04:28 +03:00
return $role['id'];
}
/**
* Remove an existing role from the database.
*
* @param int $role_id Role ID.
* @param bool $force_delete Override soft delete.
2021-10-27 11:04:28 +03:00
*
* @throws RuntimeException
*/
public function delete(int $role_id, bool $force_delete = FALSE)
2021-10-27 11:04:28 +03:00
{
if ($force_delete)
{
$this->db->delete('roles', ['id' => $role_id]);
}
else
{
$this->db->update('roles', ['delete_datetime' => date('Y-m-d H:i:s')], ['id' => $role_id]);
2021-10-27 11:04:28 +03:00
}
}
2021-10-27 11:04:28 +03:00
/**
* Get a specific role from the database.
*
* @param int $role_id The ID of the record to be returned.
* @param bool $with_trashed
2021-10-27 11:04:28 +03:00
*
* @return array Returns an array with the role data.
*
* @throws InvalidArgumentException
*/
public function find(int $role_id, bool $with_trashed = FALSE): array
2021-10-27 11:04:28 +03:00
{
if ( ! $with_trashed)
2021-10-27 11:04:28 +03:00
{
$this->db->where('delete_datetime IS NULL');
2021-10-27 11:04:28 +03:00
}
2021-10-29 13:39:08 +03:00
$role = $this->db->get_where('roles', ['id' => $role_id])->row_array();
if ( ! $role)
{
throw new InvalidArgumentException('The provided role ID was not found in the database: ' . $role_id);
}
$this->cast($role);
return $role;
2021-10-27 11:04:28 +03:00
}
/**
* Get a specific field value from the database.
*
* @param int $role_id Role ID.
* @param string $field Name of the value to be returned.
*
2023-01-14 11:39:14 +03:00
* @return mixed Returns the selected role value from the database.
2021-10-27 11:04:28 +03:00
*
* @throws InvalidArgumentException
*/
2023-01-14 11:39:14 +03:00
public function value(int $role_id, string $field): mixed
2021-10-27 11:04:28 +03:00
{
if (empty($field))
{
throw new InvalidArgumentException('The field argument is cannot be empty.');
}
if (empty($role_id))
{
throw new InvalidArgumentException('The role ID argument cannot be empty.');
}
// Check whether the role exists.
$query = $this->db->get_where('roles', ['id' => $role_id]);
if ( ! $query->num_rows())
{
throw new InvalidArgumentException('The provided role ID was not found in the database: ' . $role_id);
}
// Check if the required field is part of the role data.
$role = $query->row_array();
2021-10-29 13:39:08 +03:00
$this->cast($role);
2021-10-27 11:04:28 +03:00
if ( ! array_key_exists($field, $role))
{
throw new InvalidArgumentException('The requested field was not found in the role data: ' . $field);
}
return $role[$field];
}
/**
* Get all roles that match the provided criteria.
*
2023-03-13 11:06:18 +03:00
* @param array|string|null $where Where conditions
2021-10-27 11:04:28 +03:00
* @param int|null $limit Record limit.
* @param int|null $offset Record offset.
* @param string|null $order_by Order by.
* @param bool $with_trashed
2021-10-27 11:04:28 +03:00
*
* @return array Returns an array of roles.
*/
2023-03-13 11:06:18 +03:00
public function get(array|string $where = NULL, int $limit = NULL, int $offset = NULL, string $order_by = NULL, bool $with_trashed = FALSE): array
2021-10-27 11:04:28 +03:00
{
if ($where !== NULL)
{
$this->db->where($where);
}
if ($order_by !== NULL)
{
$this->db->order_by($order_by);
}
if ( ! $with_trashed)
{
$this->db->where('delete_datetime IS NULL');
}
2021-10-29 13:39:08 +03:00
$roles = $this->db->get('roles', $limit, $offset)->result_array();
foreach ($roles as &$role)
2021-10-29 13:39:08 +03:00
{
$this->cast($role);
2021-10-29 13:39:08 +03:00
}
2021-10-29 13:39:08 +03:00
return $roles;
2021-10-27 11:04:28 +03:00
}
/**
* Get the permissions array by role slug.
*
* The permission numbers are converted into boolean values of the four main actions:
*
* - view
* - add
* - edit
* - delete
*
* After checking each individual value, you can make sure if the user is able to perform each action or not.
*
* @param string $slug Role slug.
*
* @return array Returns the permissions value.
*/
public function get_permissions_by_slug(string $slug): array
{
$role = $this->db->get_where('roles', ['slug' => $slug])->row_array();
2021-10-29 13:39:08 +03:00
$this->cast($role);
2021-10-27 11:04:28 +03:00
unset(
$role['id'],
$role['name'],
$role['slug'],
$role['is_admin']
);
// Convert the integer values to boolean.
$permissions = [];
foreach ($role as $resource => $value)
{
$permissions[$resource] = [
'view' => FALSE,
'add' => FALSE,
'edit' => FALSE,
'delete' => FALSE
];
2021-10-27 11:04:28 +03:00
if ($value > 0)
{
2021-10-27 11:04:28 +03:00
if ((int)($value / PRIV_DELETE) === 1)
{
2021-10-27 11:04:28 +03:00
$permissions[$resource]['delete'] = TRUE;
$value -= PRIV_DELETE;
}
2021-10-27 11:04:28 +03:00
if ((int)($value / PRIV_EDIT) === 1)
{
2021-10-27 11:04:28 +03:00
$permissions[$resource]['edit'] = TRUE;
$value -= PRIV_EDIT;
}
2021-10-27 11:04:28 +03:00
if ((int)($value / PRIV_ADD) === 1)
{
2021-10-27 11:04:28 +03:00
$permissions[$resource]['add'] = TRUE;
}
2021-10-27 11:04:28 +03:00
$permissions[$resource]['view'] = TRUE;
}
}
2021-10-27 11:04:28 +03:00
return $permissions;
}
/**
* Get the query builder interface, configured for use with the roles table.
*
* @return CI_DB_query_builder
*/
public function query(): CI_DB_query_builder
{
return $this->db->from('roles');
}
/**
* Search roles 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.
* @param bool $with_trashed
2021-10-27 11:04:28 +03:00
*
* @return array Returns an array of roles.
*/
public function search(string $keyword, int $limit = NULL, int $offset = NULL, string $order_by = NULL, bool $with_trashed = FALSE): array
2021-10-27 11:04:28 +03:00
{
if ( ! $with_trashed)
{
$this->db->where('delete_datetime IS NULL');
}
2021-10-29 13:39:08 +03:00
$roles = $this
2021-10-27 11:04:28 +03:00
->db
->select()
->from('roles')
->group_start()
2021-10-27 11:04:28 +03:00
->like('name', $keyword)
->or_like('slug', $keyword)
->group_end()
2021-10-27 11:04:28 +03:00
->limit($limit)
->offset($offset)
->order_by($order_by)
->get()
->result_array();
2021-10-29 13:39:08 +03:00
foreach ($roles as &$role)
2021-10-29 13:39:08 +03:00
{
$this->cast($role);
}
return $roles;
2021-10-27 11:04:28 +03:00
}
/**
* Load related resources to a role.
2021-10-27 11:04:28 +03:00
*
* @param array $role Associative array with the role data.
* @param array $resources Resource names to be attached.
*
* @throws InvalidArgumentException
*/
public function load(array &$role, array $resources)
2021-10-27 11:04:28 +03:00
{
// Roles do not currently have any related resources.
}
}