easyappointments/src/assets/js/backend_users_secretaries.js

/* ----------------------------------------------------------------------------
 * Easy!Appointments - Open Source Web Scheduler
 *
 * @package     EasyAppointments
 * @author      A.Tselegidis <alextselegidis@gmail.com>
 * @copyright   Copyright (c) 2013 - 2016, Alex Tselegidis
 * @license     http://opensource.org/licenses/GPL-3.0 - GPLv3
 * @link        http://easyappointments.org
 * @since       v1.0.0
 * ---------------------------------------------------------------------------- */

/**
 * This class contains the Secretaries helper class declaration, along with the "Secretaries"
 * tab event handlers. By deviding the backend/users tab functionality into separate files
 * it is easier to maintain the code.
 *
 * @class SecretariesHelper
 */
var SecretariesHelper = function() {
    this.filterResults = {}; // Store the results for later use.
};

/**
 * Bind the event handlers for the backend/users "Secretaries" tab.
 */
SecretariesHelper.prototype.bindEventHandlers = function() {
    /**
     * Event: Filter Secretaries Form "Submit"
     *
     * Filter the secretary records with the given key string.
     */
    $('#filter-secretaries form').submit(function(event) {
        var key = $('#filter-secretaries .key').val();
        $('#filter-secretaries .selected-row').removeClass('selected-row');
        BackendUsers.helper.resetForm();
        BackendUsers.helper.filter(key);
        return false;
    });

    /**
     * Event: Clear Filter Results Button "Click"
     */
    $('#filter-secretaries .clear').click(function() {
        BackendUsers.helper.filter('');
        $('#filter-secretaries .key').val('');
        BackendUsers.helper.resetForm();
    });

    /**
     * Event: Filter Secretary Row "Click"
     *
     * Display the selected secretary data to the user.
     */
    $(document).on('click', '.secretary-row', function() {
        if ($('#filter-secretaries .filter').prop('disabled')) {
            $('#filter-secretaries .results').css('color', '#AAA');
            return; // exit because we are currently on edit mode
        }

        var secretaryId = $(this).attr('data-id');
        var secretary = {};
        $.each(BackendUsers.helper.filterResults, function(index, item) {
            if (item.id === secretaryId) {
                secretary = item;
                return false;
            }
        });

        BackendUsers.helper.display(secretary);
        $('#filter-secretaries .selected-row').removeClass('selected-row');
        $(this).addClass('selected-row');
        $('#edit-secretary, #delete-secretary').prop('disabled', false);
    });

    /**
     * Event: Add New Secretary Button "Click"
     */
    $('#add-secretary').click(function() {
        BackendUsers.helper.resetForm();
        $('#filter-secretaries button').prop('disabled', true);
        $('#filter-secretaries .results').css('color', '#AAA');

        $('#secretaries .add-edit-delete-group').hide();
        $('#secretaries .save-cancel-group').show();
        $('#secretaries .details').find('input, textarea').prop('readonly', false);
        $('#secretary-password, #secretary-password-confirm').addClass('required');
        $('#secretary-notifications').prop('disabled', false);
        $('#secretary-providers input[type="checkbox"]').prop('disabled', false);
    });

    /**
     * Event: Edit Secretary Button "Click"
     */
    $('#edit-secretary').click(function() {
        $('#filter-secretaries button').prop('disabled', true);
        $('#filter-secretaries .results').css('color', '#AAA');

        $('#secretaries .add-edit-delete-group').hide();
        $('#secretaries .save-cancel-group').show();
        $('#secretaries .details').find('input, textarea').prop('readonly', false);
        $('#secretary-password, #secretary-password-confirm').removeClass('required');
        $('#secretary-notifications').prop('disabled', false);
        $('#secretary-providers input[type="checkbox"]').prop('disabled', false);
    });

    /**
     * Event: Delete Secretary Button "Click"
     */
    $('#delete-secretary').click(function() {
        var secretaryId = $('#secretary-id').val();

        var messageBtns = {};
        messageBtns[EALang['delete']] = function() {
            BackendUsers.helper.delete(secretaryId);
            $('#message_box').dialog('close');
        };
        messageBtns[EALang['cancel']] = function() {
            $('#message_box').dialog('close');
        };

        GeneralFunctions.displayMessageBox(EALang['delete_secretary'],
                EALang['delete_record_prompt'], messageBtns);
    });

    /**
     * Event: Save Secretary Button "Click"
     */
    $('#save-secretary').click(function() {
        var secretary = {
            'first_name': $('#secretary-first-name').val(),
            'last_name': $('#secretary-last-name').val(),
            'email': $('#secretary-email').val(),
            'mobile_number': $('#secretary-mobile-number').val(),
            'phone_number': $('#secretary-phone-number').val(),
            'address': $('#secretary-address').val(),
            'city': $('#secretary-city').val(),
            'state': $('#secretary-state').val(),
            'zip_code': $('#secretary-zip-code').val(),
            'notes': $('#secretary-notes').val(),
            'settings': {
                'username': $('#secretary-username').val(),
                'notifications': $('#secretary-notifications').hasClass('active')
            }
        };

        // Include secretary services.
        secretary.providers = [];
        $('#secretary-providers input[type="checkbox"]').each(function() {
            if ($(this).prop('checked')) {
                secretary.providers.push($(this).attr('data-id'));
            }
        });

        // Include password if changed.
        if ($('#secretary-password').val() !== '') {
            secretary.settings.password = $('#secretary-password').val();
        }

        // Include id if changed.
        if ($('#secretary-id').val() !== '') {
            secretary.id = $('#secretary-id').val();
        }

        if (!BackendUsers.helper.validate(secretary)) return;

        BackendUsers.helper.save(secretary);
    });

    /**
     * Event: Cancel Secretary Button "Click"
     *
     * Cancel add or edit of an secretary record.
     */
    $('#cancel-secretary').click(function() {
        var id = $('#secretary-id').val();
        BackendUsers.helper.resetForm();
        if (id != '') {
            BackendUsers.helper.select(id, true);
        }
    });
};

/**
 * Save secretary record to database.
 *
 * @param {object} secretary Contains the admin record data. If an 'id' value is provided
 * then the update operation is going to be executed.
 */
SecretariesHelper.prototype.save = function(secretary) {
    var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_save_secretary',
        postData = {
            'csrfToken': GlobalVariables.csrfToken,
            'secretary': JSON.stringify(secretary)
        };

    $.post(postUrl, postData, function(response) {
        if (!GeneralFunctions.handleAjaxExceptions(response)) return;
        Backend.displayNotification(EALang['secretary_saved']);
        BackendUsers.helper.resetForm();
        $('#filter-secretaries .key').val('');
        BackendUsers.helper.filter('', response.id, true);
    }, 'json').fail(GeneralFunctions.ajaxFailureHandler);
};

/**
 * Delete a secretary record from database.
 *
 * @param {int} id Record id to be deleted.
 */
SecretariesHelper.prototype.delete = function(id) {
    var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_delete_secretary',
        postData = {
            'csrfToken': GlobalVariables.csrfToken,
            'secretary_id': id
        };

    $.post(postUrl, postData, function(response) {
        if (!GeneralFunctions.handleAjaxExceptions(response)) return;
        Backend.displayNotification(EALang['secretary_deleted']);
        BackendUsers.helper.resetForm();
        BackendUsers.helper.filter($('#filter-secretaries .key').val());
    }, 'json').fail(GeneralFunctions.ajaxFailureHandler);
};

/**
 * Validates a secretary record.
 *
 * @param {object} secretary Contains the admin data to be validated.
 * @returns {bool} Returns the validation result.
 */
SecretariesHelper.prototype.validate = function(secretary) {
    $('#secretaries .required').css('border', '');
    $('#secretary-password, #secretary-password-confirm').css('border', '');

    try {
        // Validate required fields.
        var missingRequired = false;
        $('#secretaries .required').each(function() {
            if ($(this).val() == '' || $(this).val() == undefined) {
                $(this).css('border', '2px solid red');
                missingRequired = true;
            }
        });
        if (missingRequired) {
            throw 'Fields with * are  required.';
        }

        // Validate passwords.
        if ($('#secretary-password').val() != $('#secretary-password-confirm').val()) {
            $('#secretary-password, #secretary-password-confirm').css('border', '2px solid red');
            throw 'Passwords mismatch!';
        }

        if ($('#secretary-password').val().length < BackendUsers.MIN_PASSWORD_LENGTH
                && $('#secretary-password').val() != '') {
            $('#secretary-password, #secretary-password-confirm').css('border', '2px solid red');
            throw 'Password must be at least ' + BackendUsers.MIN_PASSWORD_LENGTH
                    + ' characters long.';
        }

        // Validate user email.
        if (!GeneralFunctions.validateEmail($('#secretary-email').val())) {
            $('#secretary-email').css('border', '2px solid red');
            throw 'Invalid email address!';
        }

        // Check if username exists
        if ($('#secretary-username').attr('already-exists') ==  'true') {
            $('#secretary-username').css('border', '2px solid red');
            throw 'Username already exists.';
        }

        return true;
    } catch(exc) {
        $('#secretaries .form-message').text(exc);
        $('#secretaries .form-message').show();
        return false;
    }
};

/**
 * Resets the admin tab form back to its initial state.
 */
SecretariesHelper.prototype.resetForm = function() {
    $('#secretaries .details').find('input, textarea').val('');
    $('#secretaries .add-edit-delete-group').show();
    $('#secretaries .save-cancel-group').hide();
    $('#edit-secretary, #delete-secretary').prop('disabled', true);
    $('#secretaries .details').find('input, textarea').prop('readonly', true);
    $('#secretaries .form-message').hide();
    $('#secretary-notifications').removeClass('active');
    $('#secretary-notifications').prop('disabled', true);
    $('#secretary-providers input[type="checkbox"]').prop('checked', false);
    $('#secretary-providers input[type="checkbox"]').prop('disabled', true);
    $('#secretaries .required').css('border', '');
    $('#secretary-password, #secretary-password-confirm').css('border', '');

    $('#filter-secretaries .selected-row').removeClass('selected-row');
    $('#filter-secretaries button').prop('disabled', false);
    $('#filter-secretaries .results').css('color', '');
};

/**
 * Display a secretary record into the admin form.
 *
 * @param {object} secretary Contains the secretary record data.
 */
SecretariesHelper.prototype.display = function(secretary) {
    $('#secretary-id').val(secretary.id);
    $('#secretary-first-name').val(secretary.first_name);
    $('#secretary-last-name').val(secretary.last_name);
    $('#secretary-email').val(secretary.email);
    $('#secretary-mobile-number').val(secretary.mobile_number);
    $('#secretary-phone-number').val(secretary.phone_number);
    $('#secretary-address').val(secretary.address);
    $('#secretary-city').val(secretary.city);
    $('#secretary-state').val(secretary.state);
    $('#secretary-zip-code').val(secretary.zip_code);
    $('#secretary-notes').val(secretary.notes);

    $('#secretary-username').val(secretary.settings.username);
    if (secretary.settings.notifications == true) {
        $('#secretary-notifications').addClass('active');
    } else {
        $('#secretary-notifications').removeClass('active');
    }

    $('#secretary-providers input[type="checkbox"]').prop('checked', false);
    $.each(secretary.providers, function(index, providerId) {
        $('#secretary-providers input[type="checkbox"]').each(function() {
            if ($(this).attr('data-id') == providerId) {
                $(this).prop('checked', true);
            }
        });
    });
};

/**
 * Filters secretary records depending a string key.
 *
 * @param {string} key This is used to filter the secretary records of the database.
 * @param {numeric} selectId (OPTIONAL = undefined) If provided then the given id will be
 * selected in the filter results (only selected, not displayed).
 * @param {bool} display (OPTIONAL = false)
 */
SecretariesHelper.prototype.filter = function(key, selectId, display) {
    if (display == undefined) display = false;

    var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_filter_secretaries';
    var postData = {
        'csrfToken': GlobalVariables.csrfToken,
        'key': key
    };

    $.post(postUrl, postData, function(response) {
        if (!GeneralFunctions.handleAjaxExceptions(response)) return;

        BackendUsers.helper.filterResults = response;

        $('#filter-secretaries .results').data('jsp').destroy();
        $('#filter-secretaries .results').html('');
        $.each(response, function(index, secretary) {
            var html = SecretariesHelper.prototype.getFilterHtml(secretary);
            $('#filter-secretaries .results').append(html);
        });
        $('#filter-secretaries .results').jScrollPane({ mouseWheelSpeed: 70 });

        if (response.length == 0) {
            $('#filter-secretaries .results').html('<em>' + EALang['no_records_found'] + '</em>')
        }

        if (selectId != undefined) {
            BackendUsers.helper.select(selectId, display);
        }
    }, 'json').fail(GeneralFunctions.ajaxFailureHandler);
};

/**
 * Get an secretary row html code that is going to be displayed on the filter results list.
 *
 * @param {object} secretary Contains the secretary record data.
 * @returns {string} The html code that represents the record on the filter results list.
 */
SecretariesHelper.prototype.getFilterHtml = function(secretary) {
    var name = secretary.first_name + ' ' + secretary.last_name;
    var info = secretary.email;
    info = (secretary.mobile_number != '' && secretary.mobile_number != null)
            ? info + ', ' + secretary.mobile_number : info;
    info = (secretary.phone_number != '' && secretary.phone_number != null)
            ? info + ', ' + secretary.phone_number : info;

    var html =
            '<div class="secretary-row" data-id="' + secretary.id + '">' +
                '<strong>' + name + '</strong><br>' +
                info + '<br>' +
            '</div><hr>';

    return html;
};

/**
 * Select a specific record from the current filter results. If the secretary 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.
 */
SecretariesHelper.prototype.select = function(id, display) {
    if (display == undefined) display = false;

    $('#filter-secretaries .selected-row').removeClass('selected-row');

    $('#filter-secretaries .secretary-row').each(function() {
        if ($(this).attr('data-id') == id) {
            $(this).addClass('selected-row');
            return false;
        }
    });

    if (display) {
        $.each(BackendUsers.helper.filterResults, function(index, admin) {
            if (admin.id == id) {
                BackendUsers.helper.display(admin);
                $('#edit-secretary, #delete-secretary').prop('disabled', false);
                return false;
            }
        });
    }
};