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