ifl/iflrandevu
1
1
Fork 0
forked from mirrors/easyappointments
Code Issues 6 Pull requests Releases 3 Activity

Ported the business logic settings functionality to a new standalone page

Browse source
This commit is contained in:
alextselegidis 2021-11-18 08:49:23 +01:00
parent 753237d003
commit 2d1fb357c8
4 changed files with 505 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

114
application/controllers/settings/Business_logic.php Normal file
View file

@ -0,0 +1,114 @@
<?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 https://opensource.org/licenses/GPL-3.0 - GPLv3
* @link https://easyappointments.org
* @since v1.5.0
* ---------------------------------------------------------------------------- */
/**
* Business logic controller.
*
* Handles general settings related operations.
*
* @package Controllers
*/
class Business_logic extends EA_Controller {
/**
* @var array
*/
protected $permissions;
/**
* Business_logic constructor.
*/
public function __construct()
{
parent::__construct();
$this->load->model('appointments_model');
$this->load->model('customers_model');
$this->load->model('services_model');
$this->load->model('providers_model');
$this->load->model('roles_model');
$this->load->model('settings_model');
$this->load->library('accounts');
$this->load->library('google_sync');
$this->load->library('notifications');
$this->load->library('synchronization');
$this->load->library('timezones');
$role_slug = session('role_slug');
if ($role_slug)
{
$this->permissions = $this->roles_model->get_permissions_by_slug($role_slug);
}
}
/**
* Render the settings page.
*/
public function index()
{
session(['dest_url' => site_url('services')]);
if (cannot('view', 'services'))
{
show_error('Forbidden', 403);
}
$user_id = session('user_id');
$role_slug = session('role_slug');
$this->load->view('pages/settings/business_logic/business_logic_page', [
'page_title' => lang('settings'),
'active_menu' => PRIV_SYSTEM_SETTINGS,
'user_display_name' => $this->accounts->get_user_display_name($user_id),
'timezones' => $this->timezones->to_array(),
'privileges' => $this->roles_model->get_permissions_by_slug($role_slug),
'system_settings' => $this->settings_model->get(),
]);
}
/**
* Save general settings.
*/
public function save()
{
try
{
if ($this->permissions[PRIV_SYSTEM_SETTINGS]['edit'] == FALSE)
{
throw new Exception('You do not have the required permissions for this task.');
}
$settings = json_decode(request('settings', FALSE), TRUE);
foreach ($settings as $setting)
{
$existing_setting = $this->settings_model->query()->where('name', $setting['name'])->get()->row_array();
if ( ! empty($existing_setting))
{
$setting['id'] = $existing_setting['id'];
}
$this->settings_model->save($setting);
}
response();
}
catch (Throwable $e)
{
json_exception($e);
}
}
}

131
application/views/pages/settings/business_logic/business_logic_page.php Executable file
View file

@ -0,0 +1,131 @@
<?php
/**
* @var array $system_settings
* @var array $user_settings
* @var string $timezones
* @var array $privileges
*/
?>
<?php extend('layouts/backend/backend_layout') ?>
<?php section('content') ?>
<script src="<?= asset_url('assets/js/backend_settings_business_logic_helper.js') ?>"></script>
<script src="<?= asset_url('assets/js/backend_settings_business_logic.js') ?>"></script>
<script src="<?= asset_url('assets/js/working_plan.js') ?>"></script>
<script src="<?= asset_url('assets/vendor/jquery-ui-timepicker-addon/jquery-ui-timepicker-addon.min.js') ?>"></script>
<script src="<?= asset_url('assets/vendor/jquery-jeditable/jquery.jeditable.min.js') ?>"></script>
<script>
var GlobalVariables = {
csrfToken: <?= json_encode($this->security->get_csrf_hash()) ?>,
baseUrl: <?= json_encode(config('base_url')) ?>,
dateFormat: <?= json_encode(setting('date_format')) ?>,
timeFormat: <?= json_encode(setting('time_format')) ?>,
firstWeekday: <?= json_encode(setting('first_weekday')) ?>,
timezones: <?= json_encode($timezones) ?>,
settings: {
system: <?= json_encode($system_settings) ?>,
},
user: {
id: <?= session('user_id') ?>,
email: <?= json_encode(session('user_email')) ?>,
timezone: <?= json_encode(session('timezone')) ?>,
role_slug: <?= json_encode(session('role_slug')) ?>,
privileges: <?= json_encode($privileges) ?>
}
};
$(function () {
BackendSettingsBusinessLogic.initialize(true);
});
</script>
<div id="business-logic-page" class="container-fluid backend-page">
<div id="business-logic">
<form>
<fieldset>
<legend class="border-bottom mb-4">
<?= lang('business_logic') ?>
<?php if ($privileges[PRIV_SYSTEM_SETTINGS]['edit'] == TRUE): ?>
<button type="button" class="save-settings btn btn-primary btn-sm mb-2"
data-tippy-content="<?= lang('save') ?>">
<i class="fas fa-check-square mr-2"></i>
<?= lang('save') ?>
</button>
<?php endif ?>
</legend>
<div class="row">
<div class="col-12 col-sm-7 working-plan-wrapper">
<h4><?= lang('working_plan') ?></h4>
<span class="form-text text-muted mb-4">
<?= lang('edit_working_plan_hint') ?>
</span>
<table class="working-plan table table-striped">
<thead>
<tr>
<th><?= lang('day') ?></th>
<th><?= lang('start') ?></th>
<th><?= lang('end') ?></th>
</tr>
</thead>
<tbody><!-- Dynamic Content --></tbody>
</table>
<div class="text-right">
<button class="btn btn-outline-secondary" id="apply-global-working-plan" type="button">
<i class="fas fa-check"></i>
<?= lang('apply_to_all_providers') ?>
</button>
</div>
<br>
<h4><?= lang('book_advance_timeout') ?></h4>
<div class="form-group">
<label for="book-advance-timeout"
class="control-label"><?= lang('timeout_minutes') ?></label>
<input id="book-advance-timeout" data-field="book_advance_timeout" class="form-control"
type="number" min="15">
<p class="form-text text-muted">
<?= lang('book_advance_timeout_hint') ?>
</p>
</div>
</div>
<div class="col-12 col-sm-5 breaks-wrapper">
<h4><?= lang('breaks') ?></h4>
<span class="form-text text-muted">
<?= lang('edit_breaks_hint') ?>
</span>
<div class="mt-2">
<button type="button" class="add-break btn btn-primary">
<i class="fas fa-plus-square"></i>
<?= lang('add_break'); ?>
</button>
</div>
<br>
<table class="breaks table table-striped">
<thead>
<tr>
<th><?= lang('day') ?></th>
<th><?= lang('start') ?></th>
<th><?= lang('end') ?></th>
<th><?= lang('actions') ?></th>
</tr>
</thead>
<tbody><!-- Dynamic Content --></tbody>
</table>
</div>
</div>
</fieldset>
</form>
</div>
</div>
<?php section('content') ?>

137
assets/js/backend_settings_business_logic.js Normal file
View file

@ -0,0 +1,137 @@
/* ----------------------------------------------------------------------------
* 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
* ---------------------------------------------------------------------------- */
window.BackendSettingsBusinessLogic = window.BackendSettingsBusinessLogic || {};
/**
* Backend Settings
*
* Contains the functionality of the backend settings page. Can either work for system or user settings,
* but the actions allowed to the user are restricted to his role (only admin has full privileges).
*
* @module BackendSettingsBusinessLogic
*/
(function (exports) {
'use strict';
// Constants
exports.SETTINGS_SYSTEM = 'SETTINGS_SYSTEM';
/**
* Use this WorkingPlan class instance to perform actions on the page's working plan tables.
*
* @type {WorkingPlan}
*/
exports.wp = {};
/**
* Tab settings object.
*
* @type {Object}
*/
var settings = {};
/**
* Initialize Page
*
* @param {bool} defaultEventHandlers Optional (true), determines whether to bind the default event handlers.
*/
exports.initialize = function (defaultEventHandlers) {
defaultEventHandlers = defaultEventHandlers || true;
// Apply setting values from database.
var workingPlan = {};
GlobalVariables.settings.system.forEach(function (setting) {
$('input[data-field="' + setting.name + '"]').val(setting.value);
$('select[data-field="' + setting.name + '"]').val(setting.value);
if (setting.name === 'company_working_plan') {
workingPlan = $.parseJSON(setting.value);
}
});
exports.wp = new WorkingPlan();
exports.wp.setup(workingPlan);
exports.wp.timepickers(false);
// Set default settings helper.
settings = new SystemSettingsBusinessLogicHelper();
if (defaultEventHandlers) {
bindEventHandlers();
var $link = $('#settings-page .nav li').not('.d-none').first().find('a');
$link.tab('show');
}
// Apply Privileges
if (GlobalVariables.user.privileges.system_settings.edit === false) {
$('#business-logic').find('select, input, textarea').prop('readonly', true);
$('#business-logic').find('button').prop('disabled', true);
}
Backend.placeFooterToBottom();
};
/**
* Bind the backend/settings default event handlers.
*
* This method depends on the backend/settings html, so do not use this method on a different page.
*/
function bindEventHandlers() {
exports.wp.bindEventHandlers();
/**
* Event: Save Settings Button "Click"
*
* Store the setting changes into the database.
*/
$('.save-settings').on('click', function () {
var data = settings.get();
settings.save(data);
});
/**
* Event: Apply Global Working Plan
*/
$('#apply-global-working-plan').on('click', function () {
var buttons = [
{
text: EALang.cancel,
click: function () {
$('#message-box').dialog('close');
}
},
{
text: 'OK',
click: function () {
var url = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_apply_global_working_plan';
var data = {
csrfToken: GlobalVariables.csrfToken,
working_plan: JSON.stringify(exports.wp.get())
};
$.post(url, data)
.done(function () {
Backend.displayNotification(EALang.working_plans_got_updated);
})
.always(function () {
$('#message-box').dialog('close');
});
}
}
];
GeneralFunctions.displayMessageBox(EALang.working_plan, EALang.overwrite_existing_working_plans, buttons);
});
}
})(window.BackendSettingsBusinessLogic);

123
assets/js/backend_settings_business_logic_helper.js Normal file
View file

@ -0,0 +1,123 @@
/* ----------------------------------------------------------------------------
* 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
* ---------------------------------------------------------------------------- */
(function () {
'use strict';
/**
* "System Settings" Tab Helper Class
*
* @class SystemSettingsBusinessLogicHelper
*/
var SystemSettingsBusinessLogicHelper = function () {};
/**
* Save the system settings.
*
* This method is run after changes are detected on the tab input fields.
*
* @param {Array} settings Contains the system settings data.
*/
SystemSettingsBusinessLogicHelper.prototype.save = function (settings) {
if (!this.validate()) {
return; // Validation failed, do not proceed.
}
var url = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_save_settings';
var data = {
csrfToken: GlobalVariables.csrfToken,
settings: JSON.stringify(settings),
type: BackendSettingsBusinessLogic.SETTINGS_SYSTEM
};
$.post(url, data).done(function () {
Backend.displayNotification(EALang.settings_saved);
// Update the logo title on the header.
$('#header-logo span').text($('#company-name').val());
// Update book_advance_timeout preview
var totalMinutes = $('#book-advance-timeout').val();
var hours = Math.floor(totalMinutes / 60);
var minutes = totalMinutes % 60;
$('#book-advance-timeout-helper').text(
EALang.book_advance_timeout_hint.replace(
'{$limit}',
('0' + hours).slice(-2) + ':' + ('0' + minutes).slice(-2)
)
);
// We need to refresh the working plan.
var workingPlan = BackendSettingsBusinessLogic.wp.get();
BackendSettingsBusinessLogic.wp.setup(workingPlan);
BackendSettingsBusinessLogic.wp.timepickers(false);
});
};
/**
* Prepare the system settings array.
*
* This method uses the DOM elements of the backend/settings page, so it can't be used in another page.
*
* @return {Array} Returns the system settings array.
*/
SystemSettingsBusinessLogicHelper.prototype.get = function () {
var settings = [];
// Business Logic Tab
settings.push({
name: 'company_working_plan',
value: JSON.stringify(BackendSettingsBusinessLogic.wp.get())
});
settings.push({
name: 'book_advance_timeout',
value: $('#book-advance-timeout').val()
});
return settings;
};
/**
* Validate the settings data.
*
* If the validation fails then display a message to the user.
*
* @return {Boolean} Returns the validation result.
*/
SystemSettingsBusinessLogicHelper.prototype.validate = function () {
$('#business-logic .has-error').removeClass('has-error');
try {
// Validate required fields.
var missingRequired = false;
$('#business-logic .required').each(function (index, requiredField) {
if (!$(requiredField).val()) {
$(requiredField).closest('.form-group').addClass('has-error');
missingRequired = true;
}
});
if (missingRequired) {
throw new Error(EALang.fields_are_required);
}
return true;
} catch (error) {
Backend.displayNotification(error.message);
return false;
}
};
window.SystemSettingsBusinessLogicHelper = SystemSettingsBusinessLogicHelper;
})();