1: <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed'); 
  2: 
  3: class Appointments_Model extends CI_Model {
  4:     /**
  5:      * Class Constructor
  6:      */
  7:     public function __construct() {
  8:         parent::__construct();
  9:     }
 10:     
 11:     /**
 12:      * Add an appointment record to the database.
 13:      * 
 14:      * This method adds a new appointment to the database. If the 
 15:      * appointment doesn't exists it is going to be inserted, otherwise 
 16:      * the record is going to be updated.
 17:      * 
 18:      * @param array $appointment Associative array with the appointment 
 19:      * data. Each key has the same name with the database fields.
 20:      * @return int Returns the appointments id.
 21:      */
 22:     public function add($appointment) {
 23:         // Validate the appointment data before doing anything.
 24:         $this->validate($appointment);
 25:         
 26:         // Perform insert() or update() operation.
 27:         if (!isset($appointment['id'])) {
 28:             $appointment['id'] = $this->insert($appointment);
 29:         } else {
 30:             $this->update($appointment);
 31:         }
 32: 
 33:         return $appointment['id'];
 34:     }
 35:     
 36:     /**
 37:      * Check if a particular appointment record already exists.
 38:      * 
 39:      * This method checks wether the given appointment already exists  
 40:      * in the database. It doesn't search with the id, but by using the 
 41:      * following fields: "start_datetime", "end_datetime", "id_users_provider",
 42:      * "id_users_customer", "id_services".
 43:      * 
 44:      * @param array $appointment Associative array with the appointment's
 45:      * data. Each key has the same name with the database fields.
 46:      * @return bool Returns wether the record exists or not.
 47:      */
 48:     public function exists($appointment) {   
 49:         if (!isset($appointment['start_datetime'])
 50:                 || !isset($appointment['end_datetime'])
 51:                 || !isset($appointment['id_users_provider'])
 52:                 || !isset($appointment['id_users_customer'])
 53:                 || !isset($appointment['id_services'])) {
 54:             throw new Exception('Not all appointment field values ' 
 55:                     . 'are provided : ' . print_r($appointment, TRUE));
 56:         }
 57:         
 58:         $num_rows = $this->db->get_where('ea_appointments', array(
 59:                 'start_datetime'    => $appointment['start_datetime'],
 60:                 'end_datetime'      => $appointment['end_datetime'],
 61:                 'id_users_provider' => $appointment['id_users_provider'],
 62:                 'id_users_customer' => $appointment['id_users_customer'],
 63:                 'id_services'       => $appointment['id_services'],))
 64:                 ->num_rows();
 65:         
 66:         return ($num_rows > 0) ? TRUE : FALSE;
 67:     }
 68:     
 69:     /**
 70:      * Insert a new appointment record to the database.
 71:      * 
 72:      * @param array $appointment Associative array with the appointment's
 73:      * data. Each key has the same name with the database fields.
 74:      * @return int Returns the id of the new record.
 75:      */
 76:     private function insert($appointment) {
 77:         $appointment['book_datetime'] = date('Y-m-d H:i:s');
 78:         $appointment['hash'] = $this->generate_hash();
 79:         
 80:         if (!$this->db->insert('ea_appointments', $appointment)) {
 81:             throw new Exception('Could not insert appointment record.');
 82:         }
 83:         
 84:         return intval($this->db->insert_id());
 85:     }
 86:     
 87:     /**
 88:      * Update an existing appointment record in the database.
 89:      * 
 90:      * The appointment data argument should already include the record
 91:      * id in order to process the update operation.
 92:      * 
 93:      * @expectedException DatabaseException Raises when the update operation 
 94:      * failes to complete successfully.
 95:      * 
 96:      * @param array $appointment Associative array with the appointment's
 97:      * data. Each key has the same name with the database fields.
 98:      */
 99:     private function update($appointment) {
100:         $this->db->where('id', $appointment['id']);
101:         if (!$this->db->update('ea_appointments', $appointment)) {
102:             throw new Exception('Could not update appointment record.');
103:         }
104:     }
105:     
106:     /**
107:      * Find the database id of an appointment record. 
108:      * 
109:      * The appointment data should include the following fields in order  
110:      * to get the unique id from the database: "start_datetime", "end_datetime", 
111:      * "id_users_provider", "id_users_customer", "id_services".
112:      * 
113:      * <strong>IMPORTANT!</strong> The record must already exists in the 
114:      * database, otherwise an exception is raised.
115:      * 
116:      * @param array $appointment Array with the appointment data. The 
117:      * keys of the array should have the same names as the db fields.
118:      * @return int Returns the db id of the record that matches the apppointment
119:      * data.
120:      */
121:     public function find_record_id($appointment) {        
122:         $this->db->where(array(
123:             'start_datetime'    => $appointment['start_datetime'],
124:             'end_datetime'      => $appointment['end_datetime'],
125:             'id_users_provider' => $appointment['id_users_provider'],
126:             'id_users_customer' => $appointment['id_users_customer'],
127:             'id_services'       => $appointment['id_services']
128:         ));
129:         
130:         $result = $this->db->get('ea_appointments');
131: 
132:         if ($result->num_rows() == 0) {
133:             throw new Exception('Could not find appointment record id.');
134:         }
135:         
136:         return $result->row()->id;
137:     }
138:     
139:     /**
140:      * Validate appointment data before the insert or update operations 
141:      * are executed.
142:      * 
143:      * @param array $appointment Contains the appointment data.
144:      * @return bool Returns the validation result.
145:      */
146:     public function validate($appointment) {
147:         $this->load->helper('data_validation');
148:         
149:         // If a appointment id is given, check wether the record exists
150:         // in the database.
151:         if (isset($appointment['id'])) {
152:             $num_rows = $this->db->get_where('ea_appointments', 
153:                     array('id' => $appointment['id']))->num_rows();
154:             if ($num_rows == 0) {
155:                 throw new Exception('Provided appointment id does not '
156:                         . 'exist in the database.');
157:             }
158:         }
159: 
160:         // Check if appointment dates are valid.
161:         if (!validate_mysql_datetime($appointment['start_datetime'])) {
162:             throw new Exception('Appointment start datetime is invalid.');    
163:         }
164: 
165:         if (!validate_mysql_datetime($appointment['end_datetime'])) {
166:             throw new Exception('Appointment end datetime is invalid.');
167:         }
168: 
169:         // Check if the provider's id is valid. 
170:         $num_rows = $this->db
171:                 ->select('*')
172:                 ->from('ea_users')
173:                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
174:                 ->where('ea_users.id', $appointment['id_users_provider'])
175:                 ->where('ea_roles.slug', DB_SLUG_PROVIDER)
176:                 ->get()->num_rows();
177:         if ($num_rows == 0) {
178:             throw new Exception('Appointment provider id is invalid.');
179:         }
180: 
181:         if ($appointment['is_unavailable'] == FALSE) { 
182:             // Check if the customer's id is valid.
183:             $num_rows = $this->db
184:                     ->select('*')
185:                     ->from('ea_users')
186:                     ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
187:                     ->where('ea_users.id', $appointment['id_users_customer'])
188:                     ->where('ea_roles.slug', DB_SLUG_CUSTOMER)
189:                     ->get()->num_rows();
190:             if ($num_rows == 0) {
191:                 throw new Exception('Appointment customer id is invalid.');
192:             }
193: 
194:             // Check if the service id is valid.
195:             $num_rows = $this->db->get_where('ea_services', 
196:                     array('id' => $appointment['id_services']))->num_rows();
197:             if ($num_rows == 0) {
198:                 throw new Exception('Appointment customer id is invalid.');
199:             }
200:         }
201: 
202:         return TRUE;
203:     }
204:     
205:     /**
206:      * Delete an existing appointment record from the database.
207:      * 
208:      * @expectedException InvalidArgumentException Raises when the $appointment_id
209:      * is not an integer.
210:      * 
211:      * @param numeric $appointment_id The record id to be deleted.
212:      * @return bool Returns the delete operation result.
213:      */
214:     public function delete($appointment_id) {
215:         if (!is_numeric($appointment_id)) { 
216:             throw new Exception('Invalid argument type $appointment_id (value:"' . $appointment_id . '")');
217:         }
218:         
219:         $num_rows = $this->db->get_where('ea_appointments', array('id' => $appointment_id))->num_rows();
220:         
221:         if ($num_rows == 0) {
222:             return FALSE; // Record does not exist.
223:         }
224:         
225:         $this->db->where('id', $appointment_id);
226:         return $this->db->delete('ea_appointments');
227:     }
228:     
229:     /**
230:      * Get a specific row from the appointments table.
231:      * 
232:      * @param numeric $appointment_id The record's id to be returned.
233:      * @return array Returns an associative array with the selected
234:      * record's data. Each key has the same name as the database 
235:      * field names.
236:      */
237:     public function get_row($appointment_id) {
238:         if (!is_numeric($appointment_id)) {
239:             throw new Exception('Invalid argument given. Expected ' 
240:                     . 'integer for the $appointment_id : ' . $appointment_id);
241:         }
242:         return $this->db->get_where('ea_appointments', 
243:                 array('id' => $appointment_id))->row_array();
244:     }
245:     
246:     /**
247:      * Get a specific field value from the database.
248:      * 
249:      * @param string $field_name The field name of the value to be returned.
250:      * @param numeric $appointment_id The selected record's id.
251:      * @return string Returns the records value from the database.
252:      */
253:     public function get_value($field_name, $appointment_id) {
254:         if (!is_numeric($appointment_id)) {
255:             throw new Exception('Invalid argument given, expected ' 
256:                     . 'integer for the $appointment_id : ' . $appointment_id);
257:         }
258:         
259:         if (!is_string($field_name)) {
260:             throw new Exception('Invalid argument given, expected ' 
261:                     . 'string for the $field_name : ' . $field_name);
262:         }
263:         
264:         if ($this->db->get_where('ea_appointments', 
265:                 array('id' => $appointment_id))->num_rows() == 0) {
266:             throw new Exception('The record with the provided id ' 
267:                     . 'does not exist in the database : ' . $appointment_id);
268:         }
269:         
270:         $row_data = $this->db->get_where('ea_appointments', 
271:                 array('id' => $appointment_id))->row_array();
272:         
273:         if (!isset($row_data[$field_name])) {
274:             throw new Exception('The given field name does not ' 
275:                     . 'exist in the database : ' . $field_name);
276:         }
277:         
278:         return $row_data[$field_name];
279:     }
280:     
281:     /**
282:      * Get all, or specific records from appointment's table.
283:      * 
284:      * @example $this->Model->getBatch('id = ' . $recordId);
285:      * 
286:      * @param string $where_clause (OPTIONAL) The WHERE clause of  
287:      * the query to be executed. DO NOT INCLUDE 'WHERE' KEYWORD.
288:      * @return array Returns the rows from the database.
289:      */
290:     public function get_batch($where_clause = '') {
291:         if ($where_clause != '') {
292:             $this->db->where($where_clause);
293:         }
294:         
295:         return $this->db->get('ea_appointments')->result_array();
296:     }
297:     
298:     /**
299:      * Generate a unique hash for the given appointment data.
300:      * 
301:      * This method uses the current date-time to generate a unique 
302:      * hash string that is later used to identify this appointment. 
303:      * Hash is needed when the email is send to the user with an 
304:      * edit link.
305:      * 
306:      * @return string Returns the unique appointment hash.
307:      */
308:     public function generate_hash() {
309:         $current_date = new DateTime();
310:         return md5($current_date->getTimestamp());
311:     }
312:     
313:     /**
314:      * Inserts or updates an unavailable period record in the database.
315:      * 
316:      * @param array $unavailable Contains the unavaible data.
317:      * @return int Returns the record id.
318:      */
319:     public function add_unavailable($unavailable) {
320:         // Validate period
321:         $start = strtotime($unavailable['start_datetime']);
322:         $end = strtotime($unavailable['end_datetime']);
323:         if ($start > $end) {
324:             throw new Exception('Unavailable period start must be prior to end.');
325:         }
326:         
327:         // Validate provider record
328:         $where_clause = array(
329:             'id' => $unavailable['id_users_provider'],
330:             'id_roles' => $this->db->get_where('ea_roles', array('slug' => DB_SLUG_PROVIDER))->row()->id
331:         );
332:         
333:         if ($this->db->get_where('ea_users', $where_clause)->num_rows() == 0) {
334:             throw new Exception('Provider id was not found in database.');
335:         }
336:         
337:         // Add record to database (insert or update).
338:         if (!isset($unavailable['id'])) {
339:             $unavailable['book_datetime'] = date('Y-m-d H:i:s');
340:             $unavailable['is_unavailable'] = true;
341:             
342:             $this->db->insert('ea_appointments', $unavailable); 
343:             $unavailable['id'] = $this->db->insert_id();
344:         } else {
345:             $this->db->where(array('id' => $unavailable['id']));
346:             $this->db->update('ea_appointments', $unavailable);
347:         }
348:         
349:         return $unavailable['id'];
350:     }
351:     
352:     /**
353:      * Delete an unavailable period.
354:      * 
355:      * @param numeric $unavailable_id Record id to be deleted.
356:      */
357:     public function delete_unavailable($unavailable_id) {
358:         if (!is_numeric($unavailable_id)) { 
359:             throw new Exception('Invalid argument type $unavailable_id (value:"' . 
360:                     $unavailable_id . '")');
361:         }
362:         
363:         $num_rows = $this->db->get_where('ea_appointments', array('id' => $unavailable_id))
364:                 ->num_rows();
365:         if ($num_rows == 0) {
366:             return FALSE; // Record does not exist.
367:         }
368:         
369:         $this->db->where('id', $unavailable_id);
370:         return $this->db->delete('ea_appointments');
371:     }
372: }
373: 
374: /* End of file appointments_model.php */
375: /* Location: ./application/models/appointments_model.php */