mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-10 10:02:33 +03:00
Code Issues Projects Releases Packages Wiki Activity

Ported the general settings functionality to a new standalone page

Browse source
This commit is contained in:
alextselegidis 2021-11-18 07:53:41 +01:00
parent 7a64ced5c9
commit 753237d003
5 changed files with 551 additions and 186 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

186
application/controllers/Settings.php
View file

@ -1,186 +0,0 @@
<?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
* ---------------------------------------------------------------------------- */
/**
* Settings controller.
*
* Handles settings related operations.
*
* @package Controllers
*/
class Settings extends EA_Controller {
/**
* @var array
*/
protected $permissions;
/**
* Calendar 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->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);
}
}
/**
* Save a setting or multiple settings in the database.
*/
public function ajax_save_settings()
{
try
{
$type = request('type');
if ($type == SETTINGS_SYSTEM)
{
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);
// Check if phone number settings are valid.
$phone_number_required = FALSE;
$phone_number_shown = FALSE;
foreach ($settings as $setting)
{
if ($setting['name'] === 'require_phone_number')
{
$phone_number_required = $setting['value'];
}
if ($setting['name'] === 'show_phone_number')
{
$phone_number_shown = $setting['value'];
}
}
if ($phone_number_required && ! $phone_number_shown)
{
throw new RuntimeException('You cannot hide the phone number in the booking form while it\'s also required!');
}
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);
}
}
else if ($type == SETTINGS_USER)
{
if ($this->permissions[PRIV_USER_SETTINGS]['edit'] == FALSE)
{
throw new Exception('You do not have the required permissions for this task.');
}
$settings = json_decode(request('settings'), TRUE);
$this->users_model->save($settings);
session([
'user_email' => $settings['email'],
'username' => $settings['settings']['username'],
'timezone' => $settings['timezone'],
]);
}
response();
}
catch (Throwable $e)
{
json_exception($e);
}
}
/**
* This method checks whether the username already exists in the database.
*/
public function ajax_validate_username()
{
try
{
// We will only use the function in the admins_model because it is sufficient for the rest user types for
// now (providers, secretaries).
$username = request('username');
$user_id = request('user_id');
$is_valid = $this->admins_model->validate_username($username, $user_id);
json_response([
'is_valid' => $is_valid,
]);
}
catch (Throwable $e)
{
json_exception($e);
}
}
/**
* Apply global working plan to all providers.
*/
public function ajax_apply_global_working_plan()
{
try
{
if ($this->permissions[PRIV_SYSTEM_SETTINGS]['edit'] == FALSE)
{
throw new Exception('You do not have the required permissions for this task.');
}
$working_plan = request('working_plan');
$providers = $this->providers_model->get();
foreach ($providers as $provider)
{
$this->providers_model->set_setting($provider['id'], 'working_plan', $working_plan);
}
response();
}
catch (Throwable $e)
{
json_exception($e);
}
}
}

138
application/controllers/settings/General.php Normal file
View file

@ -0,0 +1,138 @@
<?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
* ---------------------------------------------------------------------------- */
/**
* General controller.
*
* Handles general settings related operations.
*
* @package Controllers
*/
class General extends EA_Controller {
/**
* @var array
*/
protected $permissions;
/**
* Calendar 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/general/general_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);
// Check if phone number settings are valid.
$phone_number_required = FALSE;
$phone_number_shown = FALSE;
foreach ($settings as $setting)
{
if ($setting['name'] === 'require_phone_number')
{
$phone_number_required = $setting['value'];
}
if ($setting['name'] === 'show_phone_number')
{
$phone_number_shown = $setting['value'];
}
}
if ($phone_number_required && ! $phone_number_shown)
{
throw new RuntimeException('You cannot hide the phone number in the booking form while it\'s also required!');
}
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);
}
}
}

158
application/views/pages/settings/general/general_page.php Executable file
View file

@ -0,0 +1,158 @@
<?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_general_helper.js') ?>"></script>
<script src="<?= asset_url('assets/js/backend_settings_general.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')) ?>,
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 () {
BackendSettingsGeneral.initialize(true);
});
</script>
<div id="general-page" class="container-fluid backend-page">
<div id="general">
<form>
<fieldset>
<legend class="border-bottom mb-4">
<?= lang('general_settings') ?>
<?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="wrapper row">
<div class="col-12 col-sm-6">
<div class="form-group">
<label for="company-name">
<?= lang('company_name') ?>
<span class="text-danger">*</span>
</label>
<input id="company-name" data-field="company_name" class="required form-control">
<span class="form-text text-muted">
<?= lang('company_name_hint') ?>
</span>
</div>
<div class="form-group">
<label for="company-email">
<?= lang('company_email') ?>
<span class="text-danger">*</span>
</label>
<input id="company-email" data-field="company_email" class="required form-control">
<span class="form-text text-muted">
<?= lang('company_email_hint') ?>
</span>
</div>
<div class="form-group">
<label for="company-link">
<?= lang('company_link') ?>
<span class="text-danger">*</span>
</label>
<input id="company-link" data-field="company_link" class="required form-control">
<span class="form-text text-muted">
<?= lang('company_link_hint') ?>
</span>
</div>
<div class="form-group">
<label for="date-format">
<?= lang('date_format') ?>
</label>
<select class="form-control" id="date-format" data-field="date_format">
<option value="DMY">DMY</option>
<option value="MDY">MDY</option>
<option value="YMD">YMD</option>
</select>
<span class="form-text text-muted">
<?= lang('date_format_hint') ?>
</span>
</div>
<div class="form-group">
<label for="time-format">
<?= lang('time_format') ?>
</label>
<select class="form-control" id="time-format" data-field="time_format">
<option value="<?= TIME_FORMAT_REGULAR ?>">H:MM AM/PM</option>
<option value="<?= TIME_FORMAT_MILITARY ?>">HH:MM</option>
</select>
<span class="form-text text-muted">
<?= lang('time_format_hint') ?>
</span>
</div>
<div class="form-group">
<label for="first-weekday">
<?= lang('first_weekday') ?>
</label>
<select class="form-control" id="first-weekday" data-field="first_weekday">
<option value="sunday"><?= lang('sunday') ?></option>
<option value="monday"><?= lang('monday') ?></option>
<option value="tuesday"><?= lang('tuesday') ?></option>
<option value="wednesday"><?= lang('wednesday') ?></option>
<option value="thursday"><?= lang('thursday') ?></option>
<option value="friday"><?= lang('friday') ?></option>
<option value="saturday"><?= lang('saturday') ?></option>
</select>
<span class="form-text text-muted">
<?= lang('first_weekday_hint') ?>
</span>
</div>
</div>
<div class="col-12 col-sm-6">
<div class="form-group">
<label for="google-analytics-code">
Google Analytics ID</label>
<input id="google-analytics-code" placeholder="UA-XXXXXXXX-XX or G-XXXXXXXXXX"
data-field="google_analytics_code" class="form-control">
<span class="form-text text-muted">
<?= lang('google_analytics_code_hint') ?>
</span>
</div>
<div class="form-group">
<label for="api-token">API Token</label>
<input id="api-token" data-field="api_token" class="form-control">
<span class="form-text text-muted">
<?= lang('api_token_hint') ?>
</span>
</div>
</div>
</div>
</fieldset>
</form>
</div>
</div>
<?php section('content') ?>

107
assets/js/backend_settings_general.js Normal file
View file

@ -0,0 +1,107 @@
/* ----------------------------------------------------------------------------
* 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.BackendSettingsGeneral = window.BackendSettingsGeneral || {};
/**
* 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 BackendSettingsGeneral
*/
(function (exports) {
'use strict';
// Constants
exports.SETTINGS_SYSTEM = 'SETTINGS_SYSTEM';
/**
* 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.
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 === 'customer_notifications') {
$('#customer-notifications').prop('checked', Boolean(Number(setting.value)));
}
if (setting.name === 'require_captcha') {
$('#require-captcha').prop('checked', Boolean(Number(setting.value)));
}
if (setting.name === 'require_phone_number') {
$('#require-phone-number').prop('checked', Boolean(Number(setting.value)));
}
if (setting.name === 'display_any_provider') {
$('#display-any-provider').prop('checked', Boolean(Number(setting.value)));
}
if (setting.name === 'display_cookie_notice') {
$('#display-cookie-notice').prop('checked', Boolean(Number(setting.value)));
}
});
// Set default settings helper.
settings = new SystemSettingsGeneral();
if (defaultEventHandlers) {
bindEventHandlers();
}
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() {
/**
* 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: require phone number switch "Click"
*
* make sure that our phone number is visible when it is required.
*/
$('#require-phone-number').on('click', function () {
if ($(this).prop('checked')) {
setShowToggleValue($('#show-phone-number'), true);
}
});
}
})(window.BackendSettingsGeneral);

148
assets/js/backend_settings_general_helper.js Normal file
View file

@ -0,0 +1,148 @@
/* ----------------------------------------------------------------------------
* 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 SystemSettingsGeneral
*/
var SystemSettingsGeneral = 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.
*/
SystemSettingsGeneral.prototype.save = function (settings) {
if (!this.validate()) {
return; // Validation failed, do not proceed.
}
var url = GlobalVariables.baseUrl + '/index.php/settings/general/save';
var data = {
csrfToken: GlobalVariables.csrfToken,
settings: JSON.stringify(settings),
type: BackendSettingsGeneral.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)
)
);
// Update variables also used in other setting tabs
GlobalVariables.timeFormat = $('#time-format').val();
GlobalVariables.firstWeekday = $('#first-weekday').val();
});
};
/**
* 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.
*/
SystemSettingsGeneral.prototype.get = function () {
var settings = [];
// General Settings Tab
$('#general')
.find('input, select')
.not('input:checkbox')
.each(function (index, field) {
settings.push({
name: $(field).attr('data-field'),
value: $(field).val()
});
});
settings.push({
name: 'customer_notifications',
value: $('#customer-notifications').prop('checked') ? '1' : '0'
});
settings.push({
name: 'require_captcha',
value: $('#require-captcha').prop('checked') ? '1' : '0'
});
settings.push({
name: 'require_phone_number',
value: $('#require-phone-number').prop('checked') ? '1' : '0'
});
settings.push({
name: 'display_any_provider',
value: $('#display-any-provider').prop('checked') ? '1' : '0'
});
return settings;
};
/**
* Validate the settings data.
*
* If the validation fails then display a message to the user.
*
* @return {Boolean} Returns the validation result.
*/
SystemSettingsGeneral.prototype.validate = function () {
$('#general .has-error').removeClass('has-error');
try {
// Validate required fields.
var missingRequired = false;
$('#general .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);
}
// Validate company email address.
if (!GeneralFunctions.validateEmail($('#company-email').val())) {
$('#company-email').closest('.form-group').addClass('has-error');
throw new Error(EALang.invalid_email);
}
return true;
} catch (error) {
Backend.displayNotification(error.message);
return false;
}
};
window.SystemSettingsGeneral = SystemSettingsGeneral;
})();