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

Refactored the backend_customers.js file.

Browse source
This commit is contained in:
Alex Tselegidis 2016-04-02 14:58:21 +02:00
parent d4d605bfd3
commit 00543996ef
2 changed files with 33 additions and 437 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/application/views/backend/customers.php
View file

@ -1,6 +1,9 @@
<script type="text/javascript"
src="<?php echo $base_url; ?>/assets/ext/jquery-ui/jquery-ui-timepicker-addon.js"></script>
<script type="text/javascript"
src="<?php echo $base_url; ?>/assets/js/backend_customers_helper.js"></script>
<script type="text/javascript"
src="<?php echo $base_url; ?>/assets/js/backend_customers.js"></script>

467
src/assets/js/backend_customers.js
View file

@ -9,463 +9,56 @@
* @since v1.0.0
* ---------------------------------------------------------------------------- */
window.BackendCustomers = window.BackendCustomers || {};
/**
* Backend Customers
*
* Backend Customers javasript namespace. Contains the main functionality
* of the backend customers page. If you need to use this namespace in a
* different page, do not bind the default event handlers during initialization.
*
* @namespace BackendCustomers
* @module BackendCustomers
*/
var BackendCustomers = {
(function(exports) {
'use strict';
/**
* The page helper contains methods that implement each record type functionality
* (for now there is only the CustomersHelper).
*
* @type {object}
*/
helper: {},
var helper = {};
/**
* This method initializes the backend customers page. If you use this namespace
* in a different page do not use this method.
*
* @param {bool} defaultEventHandlers (OPTIONAL = false) Whether to bind the default
* event handlers or not.
*/
initialize: function(defaultEventHandlers) {
if (defaultEventHandlers == undefined) defaultEventHandlers = false;
/**
* This method initializes the backend customers page. If you use this namespace
* in a different page do not use this method.
*
* @param {bool} defaultEventHandlers (OPTIONAL = false) Whether to bind the default
* event handlers or not.
*/
exports.initialize = function(defaultEventHandlers) {
if (defaultEventHandlers == undefined) defaultEventHandlers = false;
BackendCustomers.helper = new CustomersHelper();
BackendCustomers.helper.resetForm();
BackendCustomers.helper.filter('');
helper = new CustomersHelper();
helper.resetForm();
helper.filter('');
$('#filter-customers .results').jScrollPane();
$('#customer-appointments').jScrollPane();
if (defaultEventHandlers) {
BackendCustomers.bindEventHandlers();
}
},
if (defaultEventHandlers) {
_bindEventHandlers();
}
};
/**
* Default event handlers declaration for backend customers page.
*/
bindEventHandlers: function() {
CustomersHelper.prototype.bindEventHandlers();
}
};
function _bindEventHandlers() {
helper.bindEventHandlers();
}
/**
* This class contains the methods that are used in the backend customers page.
*
* @class CustomersHelper
*/
var CustomersHelper = function() {
this.filterResults = {};
};
/**
* Binds the default event handlers of the backend customers page.
*/
CustomersHelper.prototype.bindEventHandlers = function() {
/**
* Event: Filter Customers Form "Submit"
*/
$('#filter-customers form').submit(function(event) {
var key = $('#filter-customers .key').val();
$('#filter-customers .selected-row').removeClass('selected-row');
BackendCustomers.helper.resetForm();
BackendCustomers.helper.filter(key);
return false;
});
/**
* Event: Filter Customers Clear Button "Click"
*/
$('#filter-customers .clear').click(function() {
$('#filter-customers .key').val('');
BackendCustomers.helper.filter('');
BackendCustomers.helper.resetForm();
});
/**
* Event: Customer Row "Click"
*
* Display the customer data of the selected row.
*/
$(document).on('click', '.customer-row', function() {
if ($('#filter-customers .filter').prop('disabled')) {
return; // Do nothing when user edits a customer record.
}
var customerId = $(this).attr('data-id');
var customer = {};
$.each(BackendCustomers.helper.filterResults, function(index, item) {
if (item.id == customerId) {
customer = item;
return false;
}
});
BackendCustomers.helper.display(customer);
$('#filter-customers .selected-row').removeClass('selected-row');
$(this).addClass('selected-row');
$('#edit-customer, #delete-customer').prop('disabled', false);
});
/**
* Event: Appointment Row "Click"
*
* Display appointment data of the selected row.
*/
$(document).on('click', '.appointment-row', function() {
$('#customer-appointments .selected-row').removeClass('selected-row');
$(this).addClass('selected-row');
var customerId = $('#filter-customers .selected-row').attr('data-id');
var appointmentId = $(this).attr('data-id');
var appointment = {};
$.each(BackendCustomers.helper.filterResults, function(index, c) {
if (c.id === customerId) {
$.each(c.appointments, function(index, a) {
if (a.id == appointmentId) {
appointment = a;
return false;
}
});
return false;
}
});
BackendCustomers.helper.displayAppointment(appointment);
});
/**
* Event: Add Customer Button "Click"
*/
$('#add-customer').click(function() {
BackendCustomers.helper.resetForm();
$('#add-edit-delete-group').hide();
$('#save-cancel-group').show();
$('.details').find('input, textarea').prop('readonly', false);
$('#filter-customers button').prop('disabled', true);
$('#filter-customers .results').css('color', '#AAA');
});
/**
* Event: Edit Customer Button "Click"
*/
$('#edit-customer').click(function() {
$('.details').find('input, textarea').prop('readonly', false);
$('#add-edit-delete-group').hide();
$('#save-cancel-group').show();
$('#filter-customers button').prop('disabled', true);
$('#filter-customers .results').css('color', '#AAA');
});
/**
* Event: Cancel Customer Add/Edit Operation Button "Click"
*/
$('#cancel-customer').click(function() {
var id = $('#customer-id').val();
BackendCustomers.helper.resetForm();
if (id != '') {
BackendCustomers.helper.select(id, true);
}
});
/**
* Event: Save Add/Edit Customer Operation "Click"
*/
$('#save-customer').click(function() {
var customer = {
'first_name': $('#first-name').val(),
'last_name': $('#last-name').val(),
'email': $('#email').val(),
'phone_number': $('#phone-number').val(),
'address': $('#address').val(),
'city': $('#city').val(),
'zip_code': $('#zip-code').val(),
'notes': $('#notes').val()
};
if ($('#customer-id').val() != '') {
customer.id = $('#customer-id').val();
}
if (!BackendCustomers.helper.validate(customer)) return;
BackendCustomers.helper.save(customer);
});
/**
* Event: Delete Customer Button "Click"
*/
$('#delete-customer').click(function() {
var customerId = $('#customer-id').val();
var messageBtns = {};
messageBtns[EALang['delete']] = function() {
BackendCustomers.helper.delete(customerId);
$('#message_box').dialog('close');
};
messageBtns[EALang['cancel']] = function() {
$('#message_box').dialog('close');
};
GeneralFunctions.displayMessageBox(EALang['delete_customer'],
EALang['delete_record_prompt'], messageBtns);
});
};
/**
* Save a customer record to the database (via ajax post).
*
* @param {object} customer Contains the customer data.
*/
CustomersHelper.prototype.save = function(customer) {
var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_save_customer';
var postData = {
'csrfToken': GlobalVariables.csrfToken,
'customer': JSON.stringify(customer)
};
$.post(postUrl, postData, function(response) {
if (!GeneralFunctions.handleAjaxExceptions(response)) return;
Backend.displayNotification(EALang['customer_saved']);
BackendCustomers.helper.resetForm();
$('#filter-customers .key').val('');
BackendCustomers.helper.filter('', response.id, true);
}, 'json').fail(GeneralFunctions.ajaxFailureHandler);
};
/**
* Delete a customer record from database.
*
* @param {numeric} id Record id to be deleted.
*/
CustomersHelper.prototype.delete = function(id) {
var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_delete_customer';
var postData = {
'csrfToken': GlobalVariables.csrfToken,
'customer_id': id
};
$.post(postUrl, postData, function(response) {
if (!GeneralFunctions.handleAjaxExceptions(response)) return;
Backend.displayNotification(EALang['customer_deleted']);
BackendCustomers.helper.resetForm();
BackendCustomers.helper.filter($('#filter-customers .key').val());
}, 'json').fail(GeneralFunctions.ajaxFailureHandler);
};
/**
* Validate customer data before save (insert or update).
*
* @param {object} customer Contains the customer data.
*/
CustomersHelper.prototype.validate = function(customer) {
$('#form-message').hide();
$('.required').css('border', '');
try {
// Validate required fields.
var missingRequired = false;
$('.required').each(function() {
if ($(this).val() == '') {
$(this).css('border', '2px solid red');
missingRequired = true;
}
});
if (missingRequired) {
throw EALang['fields_are_required'];
}
// Validate email address.
if (!GeneralFunctions.validateEmail($('#email').val())) {
$('#email').css('border', '2px solid red');
throw EALang['invalid_email'];
}
return true;
} catch(exc) {
$('#form-message').text(exc).show();
return false;
}
};
/**
* Bring the customer form back to its initial state.
*/
CustomersHelper.prototype.resetForm = function() {
$('.details').find('input, textarea').val('');
$('.details').find('input, textarea').prop('readonly', true);
$('#customer-appointments').html('');
$('#appointment-details').html('');
$('#edit-customer, #delete-customer').prop('disabled', true);
$('#add-edit-delete-group').show();
$('#save-cancel-group').hide();
$('.details .required').css('border', '');
$('.details #form-message').hide();
$('#filter-customers button').prop('disabled', false);
$('#filter-customers .selected-row').removeClass('selected-row');
$('#filter-customers .results').css('color', '');
};
/**
* Display a customer record into the form.
*
* @param {object} customer Contains the customer record data.
*/
CustomersHelper.prototype.display = function(customer) {
$('#customer-id').val(customer.id);
$('#first-name').val(customer.first_name);
$('#last-name').val(customer.last_name);
$('#email').val(customer.email);
$('#phone-number').val(customer.phone_number);
$('#address').val(customer.address);
$('#city').val(customer.city);
$('#zip-code').val(customer.zip_code);
$('#notes').val(customer.notes);
$('#customer-appointments').data('jsp').destroy();
$('#customer-appointments').empty();
$.each(customer.appointments, function(index, appointment) {
var start = GeneralFunctions.formatDate(Date.parse(appointment.start_datetime), GlobalVariables.dateFormat, true),
end = GeneralFunctions.formatDate(Date.parse(appointment.end_datetime), GlobalVariables.dateFormat, true);
var html =
'<div class="appointment-row" data-id="' + appointment.id + '">' +
start + ' - ' + end + '<br>' +
appointment.service.name + ', ' +
appointment.provider.first_name + ' ' + appointment.provider.last_name +
'</div>';
$('#customer-appointments').append(html);
});
$('#customer-appointments').jScrollPane({ mouseWheelSpeed: 70 });
$('#appointment-details').empty();
};
/**
* Filter customer records.
*
* @param {string} key This key string is used to filter the customer records.
* @param {numeric} selectId (OPTIONAL = undefined) If set then after the filter
* operation the record with the given id will be selected (but not displayed).
* @param {bool} display (OPTIONAL = false) If true then the selected record will
* be displayed on the form.
*/
CustomersHelper.prototype.filter = function(key, selectId, display) {
if (display == undefined) display = false;
var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_filter_customers';
var postData = {
'csrfToken': GlobalVariables.csrfToken,
'key': key
};
$.post(postUrl, postData, function(response) {
if (!GeneralFunctions.handleAjaxExceptions(response)) return;
BackendCustomers.helper.filterResults = response;
$('#filter-customers .results').data('jsp').destroy();
$('#filter-customers .results').html('');
$.each(response, function(index, customer) {
var html = BackendCustomers.helper.getFilterHtml(customer);
$('#filter-customers .results').append(html);
});
$('#filter-customers .results').jScrollPane({ mouseWheelSpeed: 70 });
if (response.length == 0) {
$('#filter-customers .results').html('<em>' + EALang['no_records_found'] + '</em>');
}
if (selectId != undefined) {
BackendCustomers.helper.select(selectId, display);
}
}, 'json').fail(GeneralFunctions.ajaxFailureHandler);
};
/**
* Get the filter results row html code.
*
* @param {object} customer Contains the customer data.
* @return {string} Returns the record html code.
*/
CustomersHelper.prototype.getFilterHtml = function(customer) {
var name = customer.first_name + ' ' + customer.last_name;
var info = customer.email;
info = (customer.phone_number != '' && customer.phone_number != null)
? info + ', ' + customer.phone_number : info;
var html =
'<div class="customer-row" data-id="' + customer.id + '">' +
'<strong>' +
name +
'</strong><br>' +
info +
'</div><hr>';
return html;
};
/**
* Select a specific record from the current filter results. If the customer id does not exist
* in the list then no record will be selected.
*
* @param {numeric} id The record id to be selected from the filter results.
* @param {bool} display (OPTIONAL = false) If true then the method will display the record
* on the form.
*/
CustomersHelper.prototype.select = function(id, display) {
if (display == undefined) display = false;
$('#filter-customers .selected-row').removeClass('selected-row');
$('#filter-customers .customer-row').each(function() {
if ($(this).attr('data-id') == id) {
$(this).addClass('selected-row');
return false;
}
});
if (display) {
$.each(BackendCustomers.helper.filterResults, function(index, customer) {
if (customer.id == id) {
BackendCustomers.helper.display(customer);
$('#edit-customer, #delete-customer').prop('disabled', false);
return false;
}
});
}
};
/**
* Display appointment details on customers backend page.
*
* @param {object} appointment Appointment data
*/
CustomersHelper.prototype.displayAppointment = function(appointment) {
var start = GeneralFunctions.formatDate(Date.parse(appointment.start_datetime), GlobalVariables.dateFormat, true),
end = GeneralFunctions.formatDate(Date.parse(appointment.end_datetime), GlobalVariables.dateFormat, true);
var html =
'<div>' +
'<strong>' + appointment.service.name + '</strong><br>' +
appointment.provider.first_name + ' ' + appointment.provider.last_name + '<br>' +
start + ' - ' + end + '<br>' +
'</div>';
$('#appointment-details').html(html);
};
})(window.BackendCustomers);