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:      * @expectedException ValidationException
 19:      * @expectedException DatabaseException
 20:      * 
 21:      * @param array $appointment_data Associative array with the appointmet's 
 22:      * data. Each key has the same name with the database fields.
 23:      * @return int Returns the appointments id.
 24:      */
 25:     public function add($appointment_data) {
 26:         // Validate the appointment data before doing anything.
 27:         if (!$this->validate_data($appointment_data)) {
 28:             throw new ValidationException('Appointment data are not valid');
 29:         }
 30: 
 31:         // Insert or update the appointment data.
 32:         if (!$this->exists($appointment_data)) {
 33:             $appointment_data['id'] = $this->insert($appointment_data);
 34:         } else {
 35:             $appointment_data['id'] = $this->update($appointment_data);
 36:         }
 37: 
 38:         return $appointment_data['id'];
 39:     }
 40:     
 41:     /**
 42:      * Check if a particular appointment record already exists.
 43:      * 
 44:      * This method checks wether the given appointment already exists  
 45:      * in the database. It doesn't search with the id, but by using the 
 46:      * following fields: "start_datetime", "end_datetime", "id_users_provider",
 47:      * "id_users_customer", "id_services".
 48:      * 
 49:      * @expectedException InvalidArgumentException When the $appointment_data
 50:      * array does not contain the necessary field.
 51:      * 
 52:      * @param array $appointment_data Associative array with the appointment's
 53:      * data. Each key has the same name with the database fields.
 54:      * @return bool Returns wether the record exists or not.
 55:      */
 56:     public function exists($appointment_data) {   
 57:         if (!isset($appointment_data['start_datetime'])
 58:                 || !isset($appointment_data['end_datetime'])
 59:                 || !isset($appointment_data['id_users_provider'])
 60:                 || !isset($appointment_data['id_users_customer'])
 61:                 || !isset($appointment_data['id_services'])) {
 62:             throw new InvalidArgumentException('Not all appointment field values are provided : ' . print_r($appointment_data, TRUE));
 63:         }
 64:         
 65:         $num_rows = $this->db->get_where('ea_appointments', array(
 66:                             'start_datetime' => $appointment_data['start_datetime'],
 67:                             'end_datetime' => $appointment_data['end_datetime'],
 68:                             'id_users_provider' => $appointment_data['id_users_provider'],
 69:                             'id_users_customer' => $appointment_data['id_users_customer'],
 70:                             'id_services' => $appointment_data['id_services'],
 71:                         ))->num_rows();
 72:         
 73:         return ($num_rows > 0) ? TRUE : FALSE;
 74:     }
 75:     
 76:     /**
 77:      * Insert a new appointment record to the database.
 78:      * 
 79:      * @expectedException DatabaseException
 80:      * 
 81:      * @param array $appointment_data Associative array with the appointment's
 82:      * data. Each key has the same name with the database fields.
 83:      * @return int Returns the id of the new record.
 84:      */
 85:     private function insert($appointment_data) {
 86:         if (!$this->db->insert('ea_appointments', $appointment_data)) {
 87:             throw new DatabaseException('Could not insert appointment record.');
 88:         }
 89:         return intval($this->db->insert_id());
 90:     }
 91:     
 92:     /**
 93:      * Update an existing appointment record in the database.
 94:      * 
 95:      * The appointment data argument should already include the record
 96:      * id in order to process the update operation.
 97:      * 
 98:      * @param array $appointment_data Associative array with the appointment's
 99:      * data. Each key has the same name with the database fields.
100:      * @return int Returns the id of the updated record.
101:      */
102:     private function update($appointment_data) {
103:         if (!isset($appointment_data['id'])) {
104:             $appointment_data['id'] = $this->find_record_id($appointment_data);
105:         }
106:         
107:         $this->db->where('id', $appointment_data['id']);
108:         if (!$this->db->update('ea_appointments', $appointment_data)) {
109:             throw new DatabaseException('Could not update appointment record.');
110:         }
111:         
112:         return intval($appointment_data['id']);
113:     }
114:     
115:     /**
116:      * Find the database id of an appointment record. 
117:      * 
118:      * The appointment data should include the following fields in order to 
119:      * get the unique id from the database: start_datetime, end_datetime, 
120:      * id_users_provider, id_users_customer, id_services.
121:      * 
122:      * <strong>IMPORTANT!</strong> The record must already exists in the 
123:      * database, otherwise an exception is raised.
124:      * 
125:      * @expectedException DatabaseException
126:      * 
127:      * @param array $appointment_data Array with the appointment data. The 
128:      * keys of the array should have the same names as the db fields.
129:      * @return int Returns the id.
130:      */
131:     public function find_record_id($appointment_data) {
132:         $this->db->where(array(
133:             'start_datetime'    => $appointment_data['start_datetime'],
134:             'end_datetime'      => $appointment_data['end_datetime'],
135:             'id_users_provider' => $appointment_data['id_users_provider'],
136:             'id_users_customer' => $appointment_data['id_users_customer'],
137:             'id_services'       => $appointment_data['id_services']
138:         ));
139:         
140:         $result = $this->db->get('ea_appointments');
141: 
142:         if ($result->num_rows() == 0) {
143:             throw new DatabaseException('Could not find appointment record id.');
144:         }
145:         
146:         return $result->row()->id;
147:     }
148:     
149:     /**
150:      * Validate appointment data before the insert or 
151:      * update operation is executed.
152:      * 
153:      * @param array $appointment_data Contains the appointment data.
154:      * @return bool Returns the validation result.
155:      */
156:     public function validate_data($appointment_data) {
157:         $this->load->helper('data_validation');
158:         
159:         try {
160:             // Check if appointment dates are valid.
161:             if (!validate_mysql_datetime($appointment_data['start_datetime'])) {
162:                 throw new Exception('Appointment start datetime is invalid.');    
163:             }
164:             
165:             if (!validate_mysql_datetime($appointment_data['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_data['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:             // Check if the customer's id is valid.
182:             $num_rows = $this->db
183:                                 ->select('*')
184:                                 ->from('ea_users')
185:                                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
186:                                 ->where('ea_users.id', $appointment_data['id_users_customer'])
187:                                 ->where('ea_roles.slug', DB_SLUG_CUSTOMER)
188:                                 ->get()->num_rows();
189:             if ($num_rows == 0) {
190:                 throw new Exception('Appointment customer id is invalid.');
191:             }
192:             
193:             // Check if the service id is valid.
194:             $num_rows = $this->db->get_where('ea_services', array('id' => $appointment_data['id_services']))->num_rows();
195:             if ($num_rows == 0) {
196:                 throw new Exception('Appointment customer id is invalid.');
197:             }
198:             
199:             return TRUE;
200:         } catch (Exception $exc) {
201:             return FALSE;
202:         }
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 int $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 InvalidArgumentException('Invalid argument type $appointment_id : ' . $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 int $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 InvalidArgumentException('Invalid argument given. Expected integer for the $appointment_id : ' . $appointment_id);
240:         }
241:         return $this->db->get_where('ea_appointments', array('id' => $appointment_id))->row_array();
242:     }
243:     
244:     /**
245:      * Get a specific field value from the database.
246:      * 
247:      * @param string $field_name The field name of the value to be
248:      * returned.
249:      * @param int $appointment_id The selected record's id.
250:      * @return string Returns the records value from the database.
251:      */
252:     public function get_value($field_name, $appointment_id) {
253:         if (!is_numeric($appointment_id)) {
254:             throw new InvalidArgumentException('Invalid argument given, expected integer for the $appointment_id : ' . $appointment_id);
255:         }
256:         
257:         if (!is_string($field_name)) {
258:             throw new InvalidArgumentException('Invalid argument given, expected string for the $field_name : ' . $field_name);
259:         }
260:         
261:         if ($this->db->get_where('ea_appointments', array('id' => $appointment_id))->num_rows() == 0) {
262:             throw new InvalidArgumentException('The record with the provided id does not exist in the database : ' . $appointment_id);
263:         }
264:         
265:         $row_data = $this->db->get_where('ea_appointments', array('id' => $appointment_id))->row_array();
266:         
267:         if (!isset($row_data[$field_name])) {
268:             throw new InvalidArgumentException('The given field name does not exist in the database : ' . $field_name);
269:         }
270:         
271:         return $row_data[$field_name];
272:     }
273:     
274:     /**
275:      * Get all, or specific records from appointment's table.
276:      * 
277:      * @example $this->Model->getBatch('id = ' . $recordId);
278:      * 
279:      * @param string $where_clause (OPTIONAL) The WHERE clause of  
280:      * the query to be executed. DO NOT INCLUDE 'WHERE' KEYWORD.
281:      * @return array Returns the rows from the database.
282:      */
283:     public function get_batch($where_clause = '') {
284:         if ($where_clause != '') {
285:             $this->db->where($where_clause);
286:         }
287:         
288:         return $this->db->get('ea_appointments')->result_array();
289:     }
290: }
291: 
292: /* End of file appointments_model.php */
293: /* Location: ./application/models/appointments_model.php */