1 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed.'); 
  2 
  3 /**
  4  * Providers_Model Class
  5  * 
  6  * Contains the database operations for the service provider users of 
  7  * Easy!Appointmenst.
  8  * 
  9  * Data Structure: 
 10  *      'fist_name'
 11  *      'last_name' (required)
 12  *      'email' (required)
 13  *      'mobile_number'
 14  *      'phone_number' (required)
 15  *      'address'
 16  *      'city'
 17  *      'state'
 18  *      'zip_code'
 19  *      'notes'
 20  *      'id_roles'
 21  *      'services' >> array that contains the ids that the provider can provide
 22  *      'settings'
 23  *          'username'
 24  *          'password'
 25  *          'notifications'
 26  *          'working_plan'
 27  *          'google_sync'
 28  *          'google_token'
 29  *          'google_calendar'
 30  *          'sync_past_days'
 31  *          'sync_future_days'
 32  */
 33 class Providers_Model extends CI_Model {
 34     /**
 35      * Class Constructor
 36      */
 37     public function __construct() {
 38         parent::__construct();
 39     }
 40     
 41     /**
 42      * Add (insert - update) a service provider record. 
 43      * 
 44      * If the record already exists (id value provided) then it is going to be updated,
 45      * otherwise inserted into the database.
 46      * 
 47      * @param array $provider Contains the service provider data.
 48      * @return int Returns the record id.
 49      * @throws Exception When the record data validation fails.
 50      */
 51     public function add($provider) {
 52         $this->validate($provider);
 53         
 54         if ($this->exists($provider) && !isset($provider['id'])) {
 55             $provider['id'] = $this->find_record_id($provider);
 56         }
 57         
 58         if (!isset($provider['id'])) {
 59             $provider['id'] = $this->insert($provider);
 60         } else {
 61             $provider['id'] = $this->update($provider);
 62         }
 63         
 64         return intval($provider['id']);
 65     }
 66     
 67     /**
 68      * Check whether a particular provider record already exists in the database.
 69      *  
 70      * @param array $provider Contains the provider data. The 'email' value is required 
 71      * in order to check for a provider.
 72      * @return bool Returns whether the provider record exists or not.
 73      * @throws Exception When the 'email' value is not provided.
 74      */
 75     public function exists($provider) {
 76         if (!isset($provider['email'])) {
 77             throw new Exception('Provider email is not provided :' . print_r($provider, TRUE));
 78         }
 79         
 80         // This method shouldn't depend on another method of this class.
 81         $num_rows = $this->db
 82                 ->select('*')
 83                 ->from('ea_users')
 84                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
 85                 ->where('ea_users.email', $provider['email'])
 86                 ->where('ea_roles.slug', DB_SLUG_PROVIDER)
 87                 ->get()->num_rows();
 88         
 89         return ($num_rows > 0) ? TRUE : FALSE;
 90     }
 91     
 92     /**
 93      * Insert a new provider record into the database.
 94      *  
 95      * @param array $provider Contains the provider data (must be already validated).
 96      * @return int Returns the new record id.
 97      * @throws Exception When the insert operation fails.
 98      */
 99     public function insert($provider) {
100         $this->load->helper('general');
101         
102         // Get provider role id. 
103         $provider['id_roles'] = $this->get_providers_role_id();
104         
105         // Store provider settings and services (must not be present on the $provider array).
106         $services = $provider['services'];
107         unset($provider['services']);
108         $settings = $provider['settings'];
109         unset($provider['settings']); 
110         
111         // Insert provider record and save settings.
112         if (!$this->db->insert('ea_users', $provider)) {
113             throw new Exception('Could not insert provider into the database');
114         }
115         
116         $settings['salt'] = generate_salt();
117         $settings['password'] = hash_password($settings['salt'], $settings['password']);
118         
119         $provider['id'] = $this->db->insert_id();
120         $this->save_settings($settings, $provider['id']);
121         $this->save_services($services, $provider['id']);
122         
123         // Return the new record id.
124         return intval($provider['id']);
125     }   
126     
127     /**
128      * Update an existing provider record in the database.
129      * 
130      * @param array $provider Contains the provider data.
131      * @return int Returns the record id.
132      * @throws Exception When the update operation fails.
133      */
134     public function update($provider) {
135         $this->load->helper('general');
136         
137         // Store service and settings (must not be present on the $provider array).
138         $services = $provider['services'];
139         unset($provider['services']);
140         $settings = $provider['settings'];
141         unset($provider['settings']);
142         
143         if (isset($settings['password'])) {
144             $salt = $this->db->get_where('ea_user_settings', array('id_users' => $provider['id']))->row()->salt;
145             $settings['password'] = hash_password($salt, $settings['password']);
146         }
147         
148         // Update provider record.
149         $this->db->where('id', $provider['id']);
150         if (!$this->db->update('ea_users', $provider)) {
151             throw new Exception('Could not update provider record.');
152         }
153         
154         $this->save_services($services, $provider['id']);
155         $this->save_settings($settings, $provider['id']);
156         
157         // Return record id.
158         return intval($provider['id']);
159     }
160     
161     /**
162      * Find the database record id of a provider.
163      * 
164      * @param array $provider Contains the provider data. The 'email' value is required
165      * in order to find the record id.
166      * @return int Returns the record id.
167      * @throws Exception When the provider's email value is not provided.
168      */
169     public function find_record_id($provider) {
170         if (!isset($provider['email'])) {
171             throw new Exception('Provider email was not provided :' . print_r($provider, TRUE));
172         }
173         
174         $result = $this->db
175                 ->select('ea_users.id')
176                 ->from('ea_users')
177                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
178                 ->where('ea_users.email', $provider['email'])
179                 ->where('ea_roles.slug', DB_SLUG_PROVIDER)
180                 ->get();
181         
182         if ($result->num_rows() == 0) {
183             throw new Exception('Could not find provider record id.');
184         }
185         
186         return intval($result->row()->id);
187     }
188     
189     /**
190      * Validate provider data before the insert or  update operation is executed.
191      * 
192      * @param array $provider Contains the provider data.
193      * @return bool Returns the validation result.
194      */
195     public function validate($provider) {
196         $this->load->helper('data_validation');
197         
198         // If a provider id is present, check whether the record exist in the database.
199         if (isset($provider['id'])) {
200             $num_rows = $this->db->get_where('ea_users', 
201                     array('id' => $provider['id']))->num_rows();
202             if ($num_rows == 0) {
203                 throw new Exception('Provided record id does not exist in the database.');
204             }
205         }
206 
207         // Validate required fields.
208         if (!isset($provider['last_name'])
209                 || !isset($provider['email'])
210                 || !isset($provider['phone_number'])) { 
211             throw new Exception('Not all required fields are provided : ' . print_r($provider, TRUE));
212         }
213 
214         // Validate provider email address.
215         if (!filter_var($provider['email'], FILTER_VALIDATE_EMAIL)) {
216             throw new Exception('Invalid email address provided : ' . $provider['email']);
217         }
218 
219         // Validate provider services.
220         if (!isset($provider['services']) || !is_array($provider['services'])) {
221             throw new Exception('Invalid provider services given: ' . print_r($provider, TRUE));
222         } else { // Check if services are valid numeric values.
223             foreach($provider['services'] as $service_id) {
224                 if (!is_numeric($service_id)) {
225                     throw new Exception('A provider service with invalid id was found: ' 
226                             . print_r($provider, TRUE));
227                 }
228             }
229         }
230 
231         // Validate provider settings.
232         if (!isset($provider['settings']) || count($provider['settings']) == 0
233                 || !is_array($provider['settings'])) {
234             throw new Exception('Invalid provider settings given: ' . print_r($provider, TRUE));
235         }
236         
237         // Check if username exists.
238         if (isset($provider['settings']['username'])) {
239             $user_id = (isset($provider['id'])) ? $provider['id'] : '';
240             if (!$this->validate_username($provider['settings']['username'], $user_id)) {
241                 throw new Exception ('Username already exists. Please select a different ' 
242                         . 'username for this record.');
243             }
244         }
245 
246         // Validate provider password
247         if (isset($provider['settings']['password'])) {
248             if (strlen($provider['settings']['password']) < MIN_PASSWORD_LENGTH) {
249                 throw new Exception('The user password must be at least ' 
250                         . MIN_PASSWORD_LENGTH . ' characters long.');
251             }
252         }
253         
254         // When inserting a record the email address must be unique.
255         $provider_id = (isset($provider['id'])) ? $provider['id'] : '';
256         
257         $num_rows = $this->db
258                 ->select('*')
259                 ->from('ea_users')
260                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
261                 ->where('ea_roles.slug', DB_SLUG_PROVIDER)
262                 ->where('ea_users.email', $provider['email'])
263                 ->where('ea_users.id <>', $provider_id)
264                 ->get()
265                 ->num_rows();
266         
267         if ($num_rows > 0) {
268             throw new Exception('Given email address belongs to another provider record. ' 
269                     . 'Please use a different email.');
270         }
271 
272         return TRUE;
273     }
274     
275     /**
276      * Delete an existing provider record from the database.
277      * 
278      * @param numeric $customer_id The record id to be deleted.
279      * @return bool Returns the delete operation result.
280      * @throws Exception When the provider id value is not numeric.
281      */
282     public function delete($provider_id) {
283         if (!is_numeric($provider_id)) {
284             throw new Exception('Invalid argument type $provider_id : ' . $provider_id);
285         }
286         
287         $num_rows = $this->db->get_where('ea_users', array('id' => $provider_id))->num_rows();
288         if ($num_rows == 0) {
289             return FALSE; // Record does not exist in database.
290         }
291         
292         return $this->db->delete('ea_users', array('id' => $provider_id));
293     }
294     
295     /**
296      * Get a specific provider record from the database.
297      * 
298      * @param int $provider_id The id of the record to be returned.
299      * @return array Returns an associative array with the selected record's data. Each key 
300      * has the same name as the database field names.
301      * @throws Exception When the selected record does not exist in database.
302      */
303     public function get_row($provider_id) {
304         if (!is_numeric($provider_id)) {
305             throw new Exception('$provider_id argument is not a valid numeric value: ' . $provider_id);
306         }
307         
308         // Check if selected record exists on database. 
309         if ($this->db->get_where('ea_users', array('id' => $provider_id))->num_rows() == 0) {
310             throw new Exception('Selected record does not exist in the database.');
311         }
312         
313         // Get provider data.
314         $provider = $this->db->get_where('ea_users', array('id' => $provider_id))->row_array();
315         
316        
317         // Include provider services.
318         $services = $this->db->get_where('ea_services_providers', 
319                 array('id_users' => $provider_id))->result_array();
320         $provider['services'] = array();
321         foreach($services as $service) {
322             $provider['services'][] = $service['id_services'];
323         }
324 
325         // Include provider settings.
326         $provider['settings'] = $this->db->get_where('ea_user_settings', 
327                 array('id_users' => $provider_id))->row_array();
328         unset($provider['settings']['id_users']);
329 
330         // Return provider data array.
331         return $provider;
332     }
333     
334     /**
335      * Get a specific field value from the database.
336      * 
337      * @param string $field_name The field name of the value to be returned.
338      * @param numeric $provider_id Record id of the value to be returned.
339      * @return string Returns the selected record value from the database.
340      * @throws Exception When the $field_name argument is not a valid string.
341      * @throws Exception When the $admin_id is not a valid numeric.
342      * @throws Exception When the admin record does not exist in the database.
343      * @throws Exception When the selected field value is not present on database.
344      */
345     public function get_value($field_name, $provider_id) {
346         if (!is_numeric($provider_id)) {
347             throw new Exception('Invalid argument provided as $provider_id : ' . $provider_id);
348         }
349         
350         if (!is_string($field_name)) {
351             throw new Exception('$field_name argument is not a string : ' . $field_name);
352         }
353         
354         // Check whether the admin record exists in database.
355         $result = $this->db->get_where('ea_users', array('id' => $provider_id));
356         if ($result->num_rows() == 0) {
357             throw new Exception('The record with the $provider_id argument does not exist in '
358                     . 'the database : ' . $provider_id);
359         }
360         
361         $provider = $result->row_array();
362         if (!isset($provider[$field_name])) {
363             throw new Exception('The given $field_name argument does not exist in the '
364                     . 'database : ' . $field_name);
365         }
366         
367         return $provider[$field_name];
368     }
369     
370     /**
371      * Get all, or specific records from provider's table.
372      * 
373      * @example $this->Model->get_batch('id = ' . $recordId);
374      * 
375      * @param mixed $where_clause (OPTIONAL) The WHERE clause of the query to be executed.
376      * 
377      * NOTICE: DO NOT INCLUDE 'WHERE' KEYWORD.
378      * 
379      * @return array Returns the rows from the database.
380      */
381     public function get_batch($where_clause = '') {        
382         // CI db class may confuse two where clauses made in the same time, so 
383         // get the role id first and then apply the get_batch() where clause.
384         $role_id = $this->get_providers_role_id();
385         
386         if ($where_clause != '') {
387             $this->db->where($where_clause);
388         }
389         
390         $batch = $this->db->get_where('ea_users', 
391                 array('id_roles' => $role_id))->result_array();
392        
393         // Include each provider sevices and settings.
394         foreach($batch as &$provider) {
395             // Services
396             $services = $this->db->get_where('ea_services_providers', 
397                     array('id_users' => $provider['id']))->result_array();
398             $provider['services'] = array();
399             foreach($services as $service) {
400                 $provider['services'][] = $service['id_services'];
401             }
402             
403             // Settings
404             $provider['settings'] = $this->db->get_where('ea_user_settings', 
405                     array('id_users' => $provider['id']))->row_array();
406             unset($provider['settings']['id_users']);
407         }
408         
409         // Return provider records in an array.
410         return $batch;
411     }
412     
413     /**
414      * Get the available system providers.
415      * 
416      * This method returns the available providers and the services that can 
417      * provide.
418      * 
419      * @return array Returns an array with the providers data.
420      * 
421      * @deprecated since version 0.5 - Use get_batch() instead.
422      */
423     public function get_available_providers() {
424         // Get provider records from database.
425         $this->db
426                 ->select('ea_users.*')
427                 ->from('ea_users')  
428                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
429                 ->where('ea_roles.slug', DB_SLUG_PROVIDER);
430         
431         $providers = $this->db->get()->result_array();
432         
433         // Include each provider services and settings.
434         foreach($providers as &$provider) {
435             // Services
436             $services = $this->db->get_where('ea_services_providers', 
437                     array('id_users' => $provider['id']))->result_array();
438             $provider['services'] = array();
439             foreach($services as $service) {
440                 $provider['services'][] = $service['id_services'];
441             }
442             
443             // Settings
444             $provider['settings'] = $this->db->get_where('ea_user_settings', 
445                     array('id_users' => $provider['id']))->row_array();
446             unset($provider['settings']['id_users']);
447         }
448         
449         // Return provider records.
450         return $providers;
451     }
452     
453     /**
454      * Get the providers role id from the database.
455      * 
456      * @return int Returns the role id for the provider records.
457      */
458     public function get_providers_role_id() {       
459         return $this->db->get_where('ea_roles', array('slug' => DB_SLUG_PROVIDER))->row()->id;        
460     }
461     
462     /**
463      * Get a providers setting from the database.
464      * 
465      * @param string $setting_name The setting name that is going to be
466      * returned.
467      * @param int $provider_id The selected provider id.
468      * @return string Returs the value of the selected user setting.
469      */
470     public function get_setting($setting_name, $provider_id) {
471         $provider_settings = $this->db->get_where('ea_user_settings', 
472                 array('id_users' => $provider_id))->row_array();
473         return $provider_settings[$setting_name];
474     }
475     
476     /**
477      * Set a provider's setting value in the database. 
478      * 
479      * The provider and settings record must already exist.
480      * 
481      * @param string $setting_name The setting's name.
482      * @param string $value The setting's value.
483      * @param numeric $provider_id The selected provider id.
484      */
485     public function set_setting($setting_name, $value, $provider_id) {
486         $this->db->where(array('id_users' => $provider_id));
487         return $this->db->update('ea_user_settings', array($setting_name => $value));
488     }
489     
490     /**
491      * Save the provider settings (used from insert or update operation).
492      * 
493      * @param array $settings Contains the setting values.
494      * @param numeric $provider_id Record id of the provider.
495      */
496     private function save_settings($settings, $provider_id) {
497         if (!is_numeric($provider_id)) {
498             throw new Exception('Invalid $provider_id argument given :' . $provider_id);
499         }
500         
501         if (count($settings) == 0 || !is_array($settings)) {
502             throw new Exception('Invalid $settings argument given:' . print_r($settings, TRUE));
503         }
504         
505         // Check if the setting record exists in db.
506         if ($this->db->get_where('ea_user_settings', array('id_users' => $provider_id))
507                 ->num_rows() == 0) {
508             $this->db->insert('ea_user_settings', array('id_users' => $provider_id));
509         }
510         
511         foreach($settings as $name=>$value) {
512             $this->set_setting($name, $value, $provider_id);
513         }
514     }
515     
516     /**
517      * Save the provider services in the database (use on both insert and update operation).
518      * 
519      * @param array $services Contains the service ids that the selected provider can provide.
520      * @param numeric $provider_id The selected provider record id.
521      * @throws Exception When the $services argument type is not array.
522      * @throws Exception When the $provider_id argumetn type is not numeric.
523      */
524     private function save_services($services, $provider_id) {
525         // Validate method arguments.
526         if (!is_array($services)) {
527             throw new Exception('Invalid argument type $services: ' . $services);
528         }
529         
530         if (!is_numeric($provider_id)) {
531             throw new Exception('Invalid argument type $provider_id: ' . $provider_id);
532         }
533         
534         // Save provider services in the database (delete old records and add new).
535         $this->db->delete('ea_services_providers', array('id_users' => $provider_id));
536         foreach($services as $service_id) {
537             $service_provider = array(
538                 'id_users' => $provider_id,
539                 'id_services' => $service_id
540             );
541             $this->db->insert('ea_services_providers', $service_provider);
542         } 
543     }
544     
545     /**
546      * Validate Records Username 
547      * 
548      * @param string $username The provider records username.
549      * @param numeric $user_id The user record id.
550      * @return bool Returns the validation result.
551      */
552     public function validate_username($username, $user_id) {
553         $num_rows = $this->db->get_where('ea_user_settings', 
554                 array('username' => $username, 'id_users <> ' => $user_id))->num_rows();
555         return ($num_rows > 0) ? FALSE : TRUE;
556     }
557 }
558 
559 /* End of file providers_model.php */
560 /* Location: ./application/models/providers_model.php */

API documentation generated by ApiGen