maket/MaketRandevu
1
1
Fork 0
Code Issues 15 Pull requests Projects Releases 4 Packages Wiki Activity

Update the Backend controller class with the deprecation notice and redirect all requests to the new controllers.

Browse source
This commit is contained in:
Alex Tselegidis 2022-01-18 11:45:44 +01:00
parent 253286f0ec
commit ef3324d3b8
1 changed files with 37 additions and 289 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

326
application/controllers/Backend.php
View file

@ -11,6 +11,25 @@
* @since v1.0.0
* ---------------------------------------------------------------------------- */
/*
|------------------------------------------------------------------------------
| Deprecation Notice
|------------------------------------------------------------------------------
|
| This file is still in the project for backwards compatibility reasons and for
| providing additional information on how to migrate your code to the latest
| codebase state.
|
| Visit the Easy!Appointments Developers website for more information:
|
| https://developers.easyappointments.org
|
| Since v1.5, the methods of this controller were ported to standalone controller
| classes, that can both handle the page rendering and all asynchronous HTTP
| requests.
|
*/
/**
* Backend controller.
*
@ -20,336 +39,65 @@
*/
class Backend extends EA_Controller {
/**
* Backend constructor.
*/
public function __construct()
{
parent::__construct();
$this->load->model('admins_model');
$this->load->model('appointments_model');
$this->load->model('customers_model');
$this->load->model('providers_model');
$this->load->model('roles_model');
$this->load->model('secretaries_model');
$this->load->model('categories_model');
$this->load->model('services_model');
$this->load->model('settings_model');
$this->load->model('users_model');
$this->load->library('accounts');
$this->load->library('instance');
$this->load->library('timezones');
}
/**
* Display the main backend page.
*
* This method displays the main backend page. All login permission can view this page which displays a
* calendar with the events of the selected provider or service. If a user has more privileges he will see more
* menus at the top of the page.
* Display the calendar page.
*
* @param string $appointment_hash Appointment edit dialog will appear when the page loads (default '').
*/
public function index(string $appointment_hash = '')
{
session(['dest_url' => site_url('backend/index' . (! empty($appointment_hash) ? '/' . $appointment_hash : ''))]);
if ( ! $this->has_permissions(PRIV_APPOINTMENTS))
if (empty($appointment_hash))
{
return;
}
$calendar_view_query_param = request('view');
$user_id = session('user_id');
$user = $this->users_model->find($user_id);
$view['base_url'] = config('base_url');
$view['page_title'] = lang('calendar');
$view['user_display_name'] = $this->accounts->get_user_display_name($user_id);
$view['active_menu'] = PRIV_APPOINTMENTS;
$view['date_format'] = setting('date_format');
$view['time_format'] = setting('time_format');
$view['first_weekday'] = setting('first_weekday');
$view['company_name'] = setting('company_name');
$view['require_phone_number'] = setting('require_phone_number');
$view['available_providers'] = $this->providers_model->get_available_providers();
$view['available_services'] = $this->services_model->get_available_services();
$view['customers'] = $this->customers_model->get();
$view['calendar_view'] = ! empty($calendar_view_query_param) ? $calendar_view_query_param : $user['settings']['calendar_view'];
$view['timezones'] = $this->timezones->to_array();
$this->set_user_data($view);
if (session('role_slug') === DB_SLUG_SECRETARY)
{
$secretary = $this->secretaries_model->find(session('user_id'));
$view['secretary_providers'] = $secretary['providers'];
redirect('calendar');
}
else
{
$view['secretary_providers'] = [];
redirect('calendar/reschedule/' . $appointment_hash);
}
$results = $this->appointments_model->get(['hash' => $appointment_hash]);
if ($appointment_hash !== '' && count($results) > 0)
{
$appointment = $results[0];
$appointment['customer'] = $this->customers_model->find($appointment['id_users_customer']);
$view['edit_appointment'] = $appointment; // This will display the appointment edit dialog on page load.
}
else
{
$view['edit_appointment'] = NULL;
}
$this->load->view('pages/calendar', $view);
}
/**
* Check whether current user is logged in and has the required privileges to view a page.
*
* The backend page requires different privileges from the users to display pages. Not all pages are available to
* all users. For example secretaries should not be able to edit the system users.
*
* @param string $page This argument must match the roles field names of each section (e.g. "appointments").
* @param bool $redirect If the user has not the required privileges either not logged in or insufficient
* permissions then the user will be redirected to another page.
*
* @return bool Returns whether the user has the required privileges to view the page or not.
*/
protected function has_permissions(string $page, bool $redirect = TRUE): bool
{
// Check if user is logged in.
$user_id = session('user_id');
if ( ! $user_id)
{
if ($redirect)
{
redirect('user/login');
}
return FALSE;
}
// Check if the user has the required privileges for viewing the selected page.
$role_slug = session('role_slug');
$role_permissions = $this->db->get_where('roles', ['slug' => $role_slug])->row_array();
if ($role_permissions[$page] < PRIV_VIEW)
{
// User does not have the permission to view the page.
if ($redirect)
{
show_error(lang('no_privileges_message'), 403, lang('no_privileges'));
}
return FALSE;
}
return TRUE;
}
/**
* Set the user data in order to be available at the view and js code.
*
* @param array $view Contains the view data.
*/
protected function set_user_data(array &$view)
{
$view['user_id'] = session('user_id');
$view['user_email'] = session('user_email');
$view['timezone'] = session('timezone');
$view['role_slug'] = session('role_slug');
$view['privileges'] = $this->roles_model->get_permissions_by_slug(session('role_slug'));
}
/**
* Display the backend customers page.
*
* In this page the user can manage all the customer records of the system.
* Display the customers page.
*/
public function customers()
{
session(['dest_url' => site_url('backend/customers')]);
if ( ! $this->has_permissions(PRIV_CUSTOMERS))
{
return;
}
$view['base_url'] = config('base_url');
$view['page_title'] = lang('customers');
$view['user_display_name'] = $this->accounts->get_user_display_name(session('user_id'));
$view['active_menu'] = PRIV_CUSTOMERS;
$view['company_name'] = setting('company_name');
$view['date_format'] = setting('date_format');
$view['time_format'] = setting('time_format');
$view['first_weekday'] = setting('first_weekday');
$view['require_phone_number'] = setting('require_phone_number');
$view['customers'] = $this->customers_model->get();
$view['available_providers'] = $this->providers_model->get_available_providers();
$view['available_services'] = $this->services_model->get_available_services();
$view['timezones'] = $this->timezones->to_array();
if (session('role_slug') === DB_SLUG_SECRETARY)
{
$secretary = $this->secretaries_model->find(session('user_id'));
$view['secretary_providers'] = $secretary['providers'];
}
else
{
$view['secretary_providers'] = [];
}
$this->set_user_data($view);
$this->load->view('pages/customers', $view);
redirect('customers');
}
/**
* Displays the backend services page.
*
* Here the admin user will be able to organize and create the services that the user will be able to book
* appointments in frontend.
*
* NOTICE: The services that each provider is able to service is managed from the backend services page.
* Display the services page.
*/
public function services()
{
session(['dest_url' => site_url('backend/services')]);
if ( ! $this->has_permissions(PRIV_SERVICES))
{
return;
}
$view['base_url'] = config('base_url');
$view['page_title'] = lang('services');
$view['user_display_name'] = $this->accounts->get_user_display_name(session('user_id'));
$view['active_menu'] = PRIV_SERVICES;
$view['company_name'] = setting('company_name');
$view['date_format'] = setting('date_format');
$view['time_format'] = setting('time_format');
$view['first_weekday'] = setting('first_weekday');
$view['services'] = $this->services_model->get();
$view['categories'] = $this->categories_model->get();
$view['timezones'] = $this->timezones->to_array();
$this->set_user_data($view);
$this->load->view('pages/services', $view);
redirect('services');
}
/**
* Display the backend users page.
* Display the users page.
*
* In this page the admin user will be able to manage the system users. By this, we mean the provider, secretary and
* admin users. This is also the page where the admin defines which service can each provider provide.
* Notice: Since the "users" page is split into multiple pages (providers, secretaries, admins), this method will
* redirect to "providers" page by default
*/
public function users()
{
session(['dest_url' => site_url('backend/users')]);
if ( ! $this->has_permissions(PRIV_USERS))
{
return;
}
$view['base_url'] = config('base_url');
$view['page_title'] = lang('users');
$view['user_display_name'] = $this->accounts->get_user_display_name(session('user_id'));
$view['active_menu'] = PRIV_USERS;
$view['company_name'] = setting('company_name');
$view['date_format'] = setting('date_format');
$view['time_format'] = setting('time_format');
$view['first_weekday'] = setting('first_weekday');
$view['admins'] = $this->admins_model->get();
$view['providers'] = $this->providers_model->get();
$view['secretaries'] = $this->secretaries_model->get();
$view['services'] = $this->services_model->get();
$view['working_plan'] = setting('company_working_plan');
$view['timezones'] = $this->timezones->to_array();
$view['working_plan_exceptions'] = '{}';
$this->set_user_data($view);
$this->load->view('pages/users', $view);
redirect('providers');
}
/**
* Display the user/system settings.
* Display settings page.
*
* This page will display the user settings (name, password etc). If current user is an administrator, then he will
* be able to make change to the current Easy!Appointment instance (core settings like company name, book
* timeout).
* Notice: Since the "settings" page is split into multiple pages (general, business, booking etc), this method will
* redirect to "general" page by default.
*/
public function settings()
{
session(['dest_url' => site_url('backend/settings')]);
if (
! $this->has_permissions(PRIV_SYSTEM_SETTINGS, FALSE)
&& ! $this->has_permissions(PRIV_USER_SETTINGS))
{
return;
}
$user_id = session('user_id');
$view['base_url'] = config('base_url');
$view['page_title'] = lang('settings');
$view['user_display_name'] = $this->accounts->get_user_display_name($user_id);
$view['active_menu'] = PRIV_SYSTEM_SETTINGS;
$view['company_name'] = setting('company_name');
$view['date_format'] = setting('date_format');
$view['first_weekday'] = setting('first_weekday');
$view['time_format'] = setting('time_format');
$view['role_slug'] = session('role_slug');
$view['system_settings'] = $this->settings_model->get();
$view['user_settings'] = $this->users_model->find($user_id);
$view['timezones'] = $this->timezones->to_array();
// book_advance_timeout preview
$book_advance_timeout = setting('book_advance_timeout');
$hours = floor($book_advance_timeout / 60);
$minutes = $book_advance_timeout % 60;
$view['book_advance_timeout_preview'] = sprintf('%02d:%02d', $hours, $minutes);
$this->set_user_data($view);
$this->load->view('pages/settings', $view);
redirect('general_settings');
}
/**
* This method will update the instance to the latest available version in the server.
*
* IMPORTANT: The code files must exist in the server, this method will not fetch any new files but will update
* the database schema.
*
* This method can be used either by loading the page in the browser or by an ajax request. But it will answer with
* JSON encoded data.
* Display the update page.
*/
public function update()
{
try
{
if ( ! $this->has_permissions(PRIV_SYSTEM_SETTINGS))
{
throw new RuntimeException('You do not have the required privileges for this task.');
}
$this->instance->migrate();
$view = ['success' => TRUE];
}
catch (Throwable $e)
{
$view = ['success' => FALSE, 'exception' => $e->getMessage()];
}
$this->load->view('pages/instance_update', $view);
redirect('update');
}
}