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