easyappointments/src/application/models/secretaries_model.php

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed.'); 

/**
 * Secretaries Model
 * 
 * Handles the db actions that have to do with secretaries.
 * 
 * Data Structure
 *      'first_name'
 *      'last_name'
 *      'email'
 *      'mobile_number'
 *      'phone_number'
 *      'address'
 *      'city'
 *      'state'
 *      'zip_code'
 *      'notes'
 *      'id_roles'
 *      'provders' >> array with provider ids that the secretary handles
 */
class Secretaries_Model extends CI_Model {
    /**
     * Class Constructor
     */
    public function __construct() {
        parent::__construct();
    }
    
    /**
     * Add (insert or update) a secretary user record into database.
     * 
     * @param array $secretary Contains the secretary user data.
     * @return int Returns the record id.
     * @throws Exception When the secretary data are invalid (see validate() method).
     */
    public function add($secretary) {
        if (!$this->validate($secretary)) {
            throw new Exception('Secretary data are invalid: ' . print_r($secretary, TRUE));
        }
        
        if ($this->exists($secretary) && !isset($secretary['id'])) {
            $secretary['id'] = $this->find_record_id($secretary);
        }
        
        if (!isset($secretary['id'])) {
            $secretary['id'] = $this->insert($secretary);
        } else {
            $secretary['id'] = $this->update($secretary);
        }
        
        return intval($secretary['id']);
    }
    
    /**
     * Check whether a particular secretary record exists in the database.
     * 
     * @param array $secretary Contains the secretary data. The 'email' value is required to 
     * be present at the moment.
     * @return bool Returns whether the record exists or not.
     * @throws Exception When the 'email' value is not present on the $secretary argument.
     */
    public function exists($secretary) {
        if (!isset($secretary['email'])) {
            throw new Exception('Secretary email is not provided: ' . print_r($secretary, TRUE));
        }
        
        // This method shouldn't depend on another method of this class.
        $num_rows = $this->db
                ->select('*')
                ->from('ea_users')
                ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
                ->where('ea_users.email', $secretary['email'])
                ->where('ea_roles.slug', DB_SLUG_SECRETARY)
                ->get()->num_rows();
        
        return ($num_rows > 0) ? TRUE : FALSE;
    }
    
     /**
     * Insert a new sercretary record into the database.
     * 
     * @param array $secretary Contains the secretary data.
     * @return int Returns the new record id.
     * @throws Exception When the insert operation fails.
     */
    public function insert($secretary) {
        $providers = $secretary['providers'];
        unset($secretary['providers']);
      
        $secretary['id_roles'] = $this->get_secretary_role_id();
        
        if (!$this->db->insert('ea_users', $secretary)) {
            throw new Exception('Could not insert secretary into the database.');
        }
        
        $secretary['id'] = intval($this->db->insert_id());
        
        $this->save_providers($providers,$secretary['id']);
        
        return $secretary['id'];
    }   
    
    /**
     * Update an existing secretary record in the database.
     * 
     * @param array $secretary Contains the secretary record data.
     * @return int Retuns the record id.
     * @throws Exception When the update operation fails.
     */
    public function update($secretary) {
        $providers = $secretary['providers'];
        unset($secretary['providers']);
        
        $this->db->where('id', $secretary['id']);
        if (!$this->db->update('ea_users', $secretary)){
            throw new Exception('Could not update secretary record.');
        }
        
        $this->save_providers($providers, $secretary['id']);
        
        return intval($secretary['id']);
    }
    
    /**
     * Find the database record id of a secretary.
     * 
     * @param array $secretary Contains the secretary data. The 'email' value is required 
     * in order to find the record id.
     * @return int Returns the record id
     * @throws Exception When the 'email' value is not present on the $secretary array.
     */
    public function find_record_id($secretary) {
        if (!isset($secretary['email'])) {
            throw new Exception('Secretary email was not provided: ' . print_r($secretary, TRUE));
        }
        
        $result = $this->db
                ->select('ea_users.id')
                ->from('ea_users')
                ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
                ->where('ea_users.email', $secretary['email'])
                ->where('ea_roles.slug', DB_SLUG_SECRETARY)
                ->get();
        
        if ($result->num_rows() == 0) {
            throw new Exception('Could not find secretary record id.');
        }
        
        return intval($result->row()->id);
    }
    
    /**
     * Validate secretary user data before add() operation is executed.
     * 
     * @param array $secretary Contains the secretary user data.
     * @return bool Returns the validation result.
     */
    public function validate($secretary) {
        $this->load->helper('data_validation');
        
        try {
            // If a record id is provided then check whether the record exists in the database.
            if (isset($secretary['id'])) {
                $num_rows = $this->db->get_where('ea_users', array('id' => $secretary['id']))
                        ->num_rows();
                if ($num_rows == 0) {
                    throw new Exception('Given secretary id does not exist in database: ' . $secretary['id']);
                }
            }
            
            // Validate 'providers' value datatype (must be array)
            if (isset($secretary['provders']) && !is_array($secretary['providers'])) {
                throw new Exception('Secretary providers value is not an array.');
            }
            
            // Validate required fields integrity.
            if (!isset($secretary['last_name'])
                    || !isset($secretary['email'])
                    || !isset($secretary['phone_number'])) { 
                throw new Exception('Not all required fields are provided : ' . print_r($secretary, TRUE));
            }
            
            // Validate secretary email address.
            if (!filter_var($secretary['email'], FILTER_VALIDATE_EMAIL)) {
                throw new Exception('Invalid email address provided : ' . $secretary['email']);
            }
            
            return TRUE;
        } catch (Exception $exc) {
            return FALSE;
        }
    }
    
    /**
     * Delete an existing secretary record from the database.
     * 
     * @param numeric $secretary_id The secretary record id to be deleted.
     * @return bool Returns the delete operation result.
     * @throws Exception When the $secretary_id is not a valid numeric value.
     */
    public function delete($secretary_id) {
        if (!is_numeric($secretary_id)) {
            throw new Exception('Invalid argument type $secretary_id : ' . $secretary_id);
        }
                
        $num_rows = $this->db->get_where('ea_users', array('id' => $secretary_id))->num_rows();
        if ($num_rows == 0) {
            return FALSE; // Record does not exist in database.
        }
        
        return $this->db->delete('ea_users', array('id' => $secretary_id));
    }
    
    /**
     * Get a specific secretary record from the database.
     * 
     * @param numeric $secretary_id The id of the record to be returned.
     * @return array Returns an array with the secretary user data.
     * @throws Exception When the $secretary_id is not a valid numeric value.
     */
    public function get_row($secretary_id) {
        if (!is_numeric($secretary_id)) {
            throw new Exception('$secretary_id argument is not a valid numeric value: ' . $secretary_id);
        }
        
        $secretary = $this->db->get_where('ea_users', array('id' => $secretary_id))->row_array();
        $secretary['providers'] = $this->db->get_where('ea_secretaries_providers',
                array('id_users_secretary' => $secretary_id))->result_array();
        
        return $secretary;
    }
    
    /**
     * Get a specific field value from the database.
     * 
     * @param string $field_name The field name of the value to be returned.
     * @param numeric $secretary_id Record id of the value to be returned.
     * @return string Returns the selected record value from the database.
     * @throws Exception When the $field_name argument is not a valid string.
     * @throws Exception When the $secretary_id is not a valid numeric.
     * @throws Exception When the secretary record does not exist in the database.
     * @throws Exception When the selected field value is not present on database.
     */
    public function get_value($field_name, $secretary_id) {
        if (!is_string($field_name)) {
            throw new Exception('$field_name argument is not a string : ' . $field_name);
        }
        
        if (!is_numeric($secretary_id)) {
            throw new Exception('$secretary_id argument is not a valid numeric value: ' . $secretary_id);
        }
        
        // Check whether the secretary record exists. 
        $result = $this->db->get_where('ea_users', array('id' => $secretary_id));
        if ($result->num_rows() == 0) {
            throw new Exception('The record with the given id does not exist in the '
                    . 'database : ' . $secretary_id);
        }
        
        // Check if the required field name exist in database.
        $provider = $result->row_array();
        if (!isset($provider[$field_name])) {
            throw new Exception('The given $field_name argument does not exist in the ' 
                    . 'database: ' . $field_name);
        }
        
        return $provider[$field_name];
    }
    
    /**
     * Get all, or specific secretary records from database.
     * 
     * @param string|array $where_clause (OPTIONAL) The WHERE clause of the query to be executed. 
     * Use this to get specific secretary records.
     * @return array Returns an array with secretary records.
     */
    public function get_batch($where_clause = '') {
        $role_id = $this->get_secretary_role_id();
        
        if ($where_clause != '') {
            $this->db->where($where_clause);
        }
        
        $this->db->where('id_roles', $role_id);
        $batch = $this->db->get('ea_users')->result_array();
        
        // Include every secretary handling users.
        foreach ($batch as &$secretary) {
            $secretary['providers'] = $this->db->get_where('ea_secretaries_providers', 
                    array('id_users_secretary' => $secretary['id']))->result_array();
        }        
        
        return $batch;
    }
    
    /**
     * Get the secretary users role id. 
     * 
     * @return int Returns the role record id. 
     */
    public function get_secretary_role_id() {
        return intval($this->db->get_where('ea_roles', array('slug' => DB_SLUG_SECRETARY))->row()->id);
    }
    
    /**
     * Save a secretary hasndling users.
     * @param array $providers Contains the provider ids that are handled by the secretary.
     * @param numeric $secretary_id The selected secretary record.
     */
    private function save_providers($providers, $secretary_id) {
        if (!is_array($providers)) {
            throw new Exception('Invalid argument given $providers: ' . print_r($providers, TRUE));
        }
        
        if (count($providers) > 0) {
            foreach ($providers as $provider_id) {
                $this->db->insert('ea_secretaries_providers', array(
                    'id_users_secretary' => $secretary_id,
                    'id_users_provider' => $provider_id
                ));
            }
        }
    }
}

/* End of file secretaries_model.php */
/* Location: ./application/models/secretaries_model.php */