1: <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed.'); 
  2: 
  3: /**
  4:  * Secretaries Model
  5:  * 
  6:  * Handles the db actions that have to do with secretaries.
  7:  * 
  8:  * Data Structure
  9:  *      'first_name'
 10:  *      'last_name'
 11:  *      'email'
 12:  *      'mobile_number'
 13:  *      'phone_number'
 14:  *      'address'
 15:  *      'city'
 16:  *      'state'
 17:  *      'zip_code'
 18:  *      'notes'
 19:  *      'id_roles'
 20:  *      'providers' >> array with provider ids that the secretary handles
 21:  *      'settings' >> array with the secretary settings
 22:  */
 23: class Secretaries_Model extends CI_Model {
 24:     /**
 25:      * Class Constructor
 26:      */
 27:     public function __construct() {
 28:         parent::__construct();
 29:     }
 30:     
 31:     /**
 32:      * Add (insert or update) a secretary user record into database.
 33:      * 
 34:      * @param array $secretary Contains the secretary user data.
 35:      * @return int Returns the record id.
 36:      * @throws Exception When the secretary data are invalid (see validate() method).
 37:      */
 38:     public function add($secretary) {
 39:         if (!$this->validate($secretary)) {
 40:             throw new Exception('Secretary data are invalid: ' . print_r($secretary, TRUE));
 41:         }
 42: 
 43:         if ($this->exists($secretary) && !isset($secretary['id'])) {
 44:             $secretary['id'] = $this->find_record_id($secretary);
 45:         }
 46:         
 47:         if (!isset($secretary['id'])) {
 48:             $secretary['id'] = $this->insert($secretary);
 49:         } else {
 50:             $secretary['id'] = $this->update($secretary);
 51:         }
 52:         
 53:         return intval($secretary['id']);
 54:     }
 55:     
 56:     /**
 57:      * Check whether a particular secretary record exists in the database.
 58:      * 
 59:      * @param array $secretary Contains the secretary data. The 'email' value is required to 
 60:      * be present at the moment.
 61:      * @return bool Returns whether the record exists or not.
 62:      * @throws Exception When the 'email' value is not present on the $secretary argument.
 63:      */
 64:     public function exists($secretary) {
 65:         if (!isset($secretary['email'])) {
 66:             throw new Exception('Secretary email is not provided: ' . print_r($secretary, TRUE));
 67:         }
 68:         
 69:         // This method shouldn't depend on another method of this class.
 70:         $num_rows = $this->db
 71:                 ->select('*')
 72:                 ->from('ea_users')
 73:                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
 74:                 ->where('ea_users.email', $secretary['email'])
 75:                 ->where('ea_roles.slug', DB_SLUG_SECRETARY)
 76:                 ->get()->num_rows();
 77:         
 78:         return ($num_rows > 0) ? TRUE : FALSE;
 79:     }
 80:     
 81:      /**
 82:      * Insert a new sercretary record into the database.
 83:      * 
 84:      * @param array $secretary Contains the secretary data.
 85:      * @return int Returns the new record id.
 86:      * @throws Exception When the insert operation fails.
 87:      */
 88:     public function insert($secretary) {
 89:         $providers = $secretary['providers'];
 90:         unset($secretary['providers']);
 91:         $settings = $secretary['settings'];
 92:         unset($secretary['settings']); 
 93:         
 94:         $secretary['id_roles'] = $this->get_secretary_role_id();
 95:         
 96:         if (!$this->db->insert('ea_users', $secretary)) {
 97:             throw new Exception('Could not insert secretary into the database.');
 98:         }
 99:         
100:         $secretary['id'] = intval($this->db->insert_id());
101:         
102:         $this->save_providers($providers, $secretary['id']);
103:         $this->save_settings($settings, $secretary['id']);
104:         
105:         return $secretary['id'];
106:     }   
107:     
108:     /**
109:      * Update an existing secretary record in the database.
110:      * 
111:      * @param array $secretary Contains the secretary record data.
112:      * @return int Retuns the record id.
113:      * @throws Exception When the update operation fails.
114:      */
115:     public function update($secretary) {
116:         $providers = $secretary['providers'];
117:         unset($secretary['providers']);
118:         $settings = $secretary['settings'];
119:         unset($secretary['settings']); 
120:         
121:         $this->db->where('id', $secretary['id']);
122:         if (!$this->db->update('ea_users', $secretary)){
123:             throw new Exception('Could not update secretary record.');
124:         }
125:         
126:         $this->save_providers($providers, $secretary['id']);
127:         $this->save_settings($settings, $secretary['id']);
128:         
129:         return intval($secretary['id']);
130:     }
131:     
132:     /**
133:      * Find the database record id of a secretary.
134:      * 
135:      * @param array $secretary Contains the secretary data. The 'email' value is required 
136:      * in order to find the record id.
137:      * @return int Returns the record id
138:      * @throws Exception When the 'email' value is not present on the $secretary array.
139:      */
140:     public function find_record_id($secretary) {
141:         if (!isset($secretary['email'])) {
142:             throw new Exception('Secretary email was not provided: ' . print_r($secretary, TRUE));
143:         }
144:         
145:         $result = $this->db
146:                 ->select('ea_users.id')
147:                 ->from('ea_users')
148:                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
149:                 ->where('ea_users.email', $secretary['email'])
150:                 ->where('ea_roles.slug', DB_SLUG_SECRETARY)
151:                 ->get();
152:         
153:         if ($result->num_rows() == 0) {
154:             throw new Exception('Could not find secretary record id.');
155:         }
156:         
157:         return intval($result->row()->id);
158:     }
159:     
160:     /**
161:      * Validate secretary user data before add() operation is executed.
162:      * 
163:      * @param array $secretary Contains the secretary user data.
164:      * @return bool Returns the validation result.
165:      */
166:     public function validate($secretary) {
167:         $this->load->helper('data_validation');
168:         
169:         try {
170:             // If a record id is provided then check whether the record exists in the database.
171:             if (isset($secretary['id'])) {
172:                 $num_rows = $this->db->get_where('ea_users', array('id' => $secretary['id']))
173:                         ->num_rows();
174:                 if ($num_rows == 0) {
175:                     throw new Exception('Given secretary id does not exist in database: ' . $secretary['id']);
176:                 }
177:             }
178:             
179:             // Validate 'providers' value datatype (must be array)
180:             if (isset($secretary['providers']) && !is_array($secretary['providers'])) {
181:                 throw new Exception('Secretary providers value is not an array.');
182:             }
183:             
184:             // Validate required fields integrity.
185:             if (!isset($secretary['last_name'])
186:                     || !isset($secretary['email'])
187:                     || !isset($secretary['phone_number'])) { 
188:                 throw new Exception('Not all required fields are provided : ' . print_r($secretary, TRUE));
189:             }
190:             
191:             // Validate secretary email address.
192:             if (!filter_var($secretary['email'], FILTER_VALIDATE_EMAIL)) {
193:                 throw new Exception('Invalid email address provided : ' . $secretary['email']);
194:             }
195:             
196:             return TRUE;
197:         } catch (Exception $exc) {
198:             return FALSE;
199:         }
200:     }
201:     
202:     /**
203:      * Delete an existing secretary record from the database.
204:      * 
205:      * @param numeric $secretary_id The secretary record id to be deleted.
206:      * @return bool Returns the delete operation result.
207:      * @throws Exception When the $secretary_id is not a valid numeric value.
208:      */
209:     public function delete($secretary_id) {
210:         if (!is_numeric($secretary_id)) {
211:             throw new Exception('Invalid argument type $secretary_id : ' . $secretary_id);
212:         }
213:                 
214:         $num_rows = $this->db->get_where('ea_users', array('id' => $secretary_id))->num_rows();
215:         if ($num_rows == 0) {
216:             return FALSE; // Record does not exist in database.
217:         }
218:         
219:         return $this->db->delete('ea_users', array('id' => $secretary_id));
220:     }
221:     
222:     /**
223:      * Get a specific secretary record from the database.
224:      * 
225:      * @param numeric $secretary_id The id of the record to be returned.
226:      * @return array Returns an array with the secretary user data.
227:      * @throws Exception When the $secretary_id is not a valid numeric value.
228:      * @throws Exception When given record id does not exist in the database.
229:      */
230:     public function get_row($secretary_id) {
231:         if (!is_numeric($secretary_id)) {
232:             throw new Exception('$secretary_id argument is not a valid numeric value: ' . $secretary_id);
233:         }
234:         
235:         // Check if record exists
236:         if ($this->db->get_where('ea_users', array('id' => $secretary_id))->num_rows() == 0) {
237:             throw new Exception('The given secretary id does not match a record in the database.');
238:         }
239:         
240:         $secretary = $this->db->get_where('ea_users', array('id' => $secretary_id))->row_array();
241:         
242:         $secretary_providers = $this->db->get_where('ea_secretaries_providers', 
243:                 array('id_users_secretary' => $secretary['id']))->result_array();
244:         $secretary['providers'] = array();
245:         foreach($secretary_providers as $secretary_provider) {
246:             $secretary['providers'][] = $secretary_provider['id_users_provider'];
247:         }
248:         
249:         $secretary['settings'] = $this->db->get_where('ea_user_settings', 
250:                 array('id_users' => $secretary['id']))->row_array();
251:         unset($secretary['settings']['id_users']);
252:         
253:         return $secretary;
254:     }
255:     
256:     /**
257:      * Get a specific field value from the database.
258:      * 
259:      * @param string $field_name The field name of the value to be returned.
260:      * @param numeric $secretary_id Record id of the value to be returned.
261:      * @return string Returns the selected record value from the database.
262:      * @throws Exception When the $field_name argument is not a valid string.
263:      * @throws Exception When the $secretary_id is not a valid numeric.
264:      * @throws Exception When the secretary record does not exist in the database.
265:      * @throws Exception When the selected field value is not present on database.
266:      */
267:     public function get_value($field_name, $secretary_id) {
268:         if (!is_string($field_name)) {
269:             throw new Exception('$field_name argument is not a string : ' . $field_name);
270:         }
271:         
272:         if (!is_numeric($secretary_id)) {
273:             throw new Exception('$secretary_id argument is not a valid numeric value: ' . $secretary_id);
274:         }
275:         
276:         // Check whether the secretary record exists. 
277:         $result = $this->db->get_where('ea_users', array('id' => $secretary_id));
278:         if ($result->num_rows() == 0) {
279:             throw new Exception('The record with the given id does not exist in the '
280:                     . 'database : ' . $secretary_id);
281:         }
282:         
283:         // Check if the required field name exist in database.
284:         $provider = $result->row_array();
285:         if (!isset($provider[$field_name])) {
286:             throw new Exception('The given $field_name argument does not exist in the ' 
287:                     . 'database: ' . $field_name);
288:         }
289:         
290:         return $provider[$field_name];
291:     }
292:     
293:     /**
294:      * Get all, or specific secretary records from database.
295:      * 
296:      * @param string|array $where_clause (OPTIONAL) The WHERE clause of the query to be executed. 
297:      * Use this to get specific secretary records.
298:      * @return array Returns an array with secretary records.
299:      */
300:     public function get_batch($where_clause = '') {
301:         $role_id = $this->get_secretary_role_id();
302:         
303:         if ($where_clause != '') {
304:             $this->db->where($where_clause);
305:         }
306:         
307:         $this->db->where('id_roles', $role_id);
308:         $batch = $this->db->get('ea_users')->result_array();
309:         
310:         // Include every secretary providers.
311:         foreach ($batch as &$secretary) {
312:             $secretary_providers = $this->db->get_where('ea_secretaries_providers', 
313:                     array('id_users_secretary' => $secretary['id']))->result_array();
314:             
315:             $secretary['providers'] = array();
316:             foreach($secretary_providers as $secretary_provider) {
317:                 $secretary['providers'][] = $secretary_provider['id_users_provider'];
318:             }
319:             
320:             $secretary['settings'] = $this->db->get_where('ea_user_settings', 
321:                     array('id_users' => $secretary['id']))->row_array();
322:             unset($secretary['settings']['id_users']);
323:         }        
324:         
325:         return $batch;
326:     }
327:     
328:     /**
329:      * Get the secretary users role id. 
330:      * 
331:      * @return int Returns the role record id. 
332:      */
333:     public function get_secretary_role_id() {
334:         return intval($this->db->get_where('ea_roles', array('slug' => DB_SLUG_SECRETARY))->row()->id);
335:     }
336:     
337:     /**
338:      * Save a secretary hasndling users.
339:      * @param array $providers Contains the provider ids that are handled by the secretary.
340:      * @param numeric $secretary_id The selected secretary record.
341:      */
342:     private function save_providers($providers, $secretary_id) {
343:         if (!is_array($providers)) {
344:             throw new Exception('Invalid argument given $providers: ' . print_r($providers, TRUE));
345:         }
346:         
347:         // Delete old connections
348:         $this->db->delete('ea_secretaries_providers', array('id_users_secretary' => $secretary_id));
349:         
350:         if (count($providers) > 0) {
351:             foreach ($providers as $provider_id) {
352:                 $this->db->insert('ea_secretaries_providers', array(
353:                     'id_users_secretary' => $secretary_id,
354:                     'id_users_provider' => $provider_id
355:                 ));
356:             }
357:         }
358:     }
359:     
360:     /**
361:      * Save the secretary settings (used from insert or update operation).
362:      * 
363:      * @param array $settings Contains the setting values.
364:      * @param numeric $secretary_id Record id of the secretary.
365:      */
366:     private function save_settings($settings, $secretary_id) {
367:         if (!is_numeric($secretary_id)) {
368:             throw new Exception('Invalid $provider_id argument given :' . $secretary_id);
369:         }
370:         
371:         if (count($settings) == 0 || !is_array($settings)) {
372:             throw new Exception('Invalid $settings argument given:' . print_r($settings, TRUE));
373:         }
374:         
375:         // Check if the setting record exists in db.
376:         $num_rows = $this->db->get_where('ea_user_settings', 
377:                 array('id_users' => $secretary_id))->num_rows();
378:         if ($num_rows == 0) {
379:             $this->db->insert('ea_user_settings', array('id_users' => $secretary_id));
380:         }
381:         
382:         foreach($settings as $name => $value) {
383:             $this->set_setting($name, $value, $secretary_id);
384:         }
385:     }
386:     
387:     /**
388:      * Get a providers setting from the database.
389:      * 
390:      * @param string $setting_name The setting name that is going to be returned.
391:      * @param int $secretary_id The selected provider id.
392:      * @return string Returs the value of the selected user setting.
393:      */
394:     public function get_setting($setting_name, $secretary_id) {
395:         $provider_settings = $this->db->get_where('ea_user_settings', 
396:                 array('id_users' => $secretary_id))->row_array();
397:         return $provider_settings[$setting_name];
398:     }
399:     
400:     /**
401:      * Set a provider's setting value in the database. 
402:      * 
403:      * The provider and settings record must already exist.
404:      * 
405:      * @param string $setting_name The setting's name.
406:      * @param string $value The setting's value.
407:      * @param numeric $secretary_id The selected provider id.
408:      */
409:     public function set_setting($setting_name, $value, $secretary_id) {
410:         $this->db->where(array('id_users' => $secretary_id));
411:         return $this->db->update('ea_user_settings', array($setting_name => $value));
412:     }
413: }
414: 
415: /* End of file secretaries_model.php */
416: /* Location: ./application/models/secretaries_model.php */