1: <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed.'); 
  2: 
  3: /**
  4:  * Admins_Model Class
  5:  * 
  6:  * Handles the database actions for admin users management.
  7:  * 
  8:  * Data Structure: 
  9:  *      'fist_name'
 10:  *      'last_name' (required)
 11:  *      'email' (required)
 12:  *      'mobile_number'
 13:  *      'phone_number' (required)
 14:  *      'address'
 15:  *      'city'
 16:  *      'state'
 17:  *      'zip_code'
 18:  *      'notes'
 19:  *      'id_roles'
 20:  *      'settings' >>> array that contains user settings (username, password etc)
 21:  */
 22: class Admins_Model extends CI_Model {
 23:     /**
 24:      * Class Constructor
 25:      */
 26:     public function __construct() {
 27:         parent::__construct();
 28:     }
 29:     
 30:     /**
 31:      * Add (insert or update) an admin user record into database.
 32:      * 
 33:      * @param array $admin Contains the admin user data.
 34:      * @return int Returns the record id.
 35:      * @throws Exception When the admin data are invalid (see validate() method).
 36:      */
 37:     public function add($admin) {
 38:         if (!$this->validate($admin)) {
 39:             throw new Exception('Admin data are invalid: ' . print_r($admin, TRUE));
 40:         }
 41:         
 42:         if ($this->exists($admin) && !isset($admin['id'])) {
 43:             $admin['id'] = $this->find_record_id($admin);
 44:         }
 45:         
 46:         if (!isset($admin['id'])) {
 47:             $admin['id'] = $this->insert($admin);
 48:         } else {
 49:             $admin['id'] = $this->update($admin);
 50:         }
 51:         
 52:         return intval($admin['id']);
 53:     }
 54:     
 55:     /**
 56:      * Check whether a particular admin record exists in the database.
 57:      * 
 58:      * @param array $admin Contains the admin data. The 'email' value is required to be present
 59:      * at the moment.
 60:      * @return bool Returns whether the record exists or not.
 61:      * @throws Exception When the 'email' value is not present on the $admin argument.
 62:      */
 63:     public function exists($admin) {
 64:         if (!isset($admin['email'])) {
 65:             throw new Exception('Admin email is not provided: ' . print_r($admin, TRUE));
 66:         }
 67:         
 68:         // This method shouldn't depend on another method of this class.
 69:         $num_rows = $this->db
 70:                 ->select('*')
 71:                 ->from('ea_users')
 72:                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
 73:                 ->where('ea_users.email', $admin['email'])
 74:                 ->where('ea_roles.slug', DB_SLUG_ADMIN)
 75:                 ->get()->num_rows();
 76:         
 77:         return ($num_rows > 0) ? TRUE : FALSE;
 78:     }
 79:     
 80:     /**
 81:      * Insert a new admin record into the database.
 82:      * 
 83:      * @param array $admin Contains the admin data.
 84:      * @return int Returns the new record id.
 85:      * @throws Exception When the insert operation fails.
 86:      */
 87:     public function insert($admin) {
 88:         $admin['id_roles'] = $this->get_admin_role_id();
 89:         $settings = $admin['settings'];
 90:         unset($admin['settings']);
 91:         
 92:         $this->db->trans_begin();        
 93:         
 94:         if (!$this->db->insert('ea_users', $admin)) {
 95:             throw new Exception('Could not insert admin into the database.');
 96:         }
 97:         
 98:         $admin['id'] = intval($this->db->insert_id());
 99:         $settings['id_users'] = $admin['id'];
100:         
101:         // Insert admin settings. 
102:         if (!$this->db->insert('ea_user_settings', $settings)) {
103:             $this->db->trans_rollback();
104:             throw new Exception('Could not insert admin settings into the database.');
105:         }
106:         
107:         $this->db->trans_complete();
108:         
109:         return $admin['id'];
110:     }   
111:     
112:     /**
113:      * Update an existing admin record in the database.
114:      * 
115:      * @param array $admin Contains the admin record data.
116:      * @return int Retuns the record id.
117:      * @throws Exception When the update operation fails.
118:      */
119:     public function update($admin) {
120:         $settings = $admin['settings'];
121:         unset($admin['settings']);
122:         $settings['id_users'] = $admin['id'];
123:         
124:         $this->db->where('id', $admin['id']);
125:         if (!$this->db->update('ea_users', $admin)) {
126:             throw new Exception('Could not update admin record.');
127:         }
128:         
129:         $this->db->where('id_users', $settings['id_users']);
130:         if (!$this->db->update('ea_user_settings', $settings)) {
131:             throw new Exception('Could not update admin settings.');
132:         }
133:         
134:         return intval($admin['id']);
135:     }
136:     
137:     /**
138:      * Find the database record id of an admin user.
139:      * 
140:      * @param array $admin Contains the admin data. The 'email' value is required in order to 
141:      * find the record id.
142:      * @return int Returns the record id
143:      * @throws Exception When the 'email' value is not present on the $admin array.
144:      */
145:     public function find_record_id($admin) {
146:         if (!isset($admin['email'])) {
147:             throw new Exception('Admin email was not provided: ' . print_r($admin, TRUE));
148:         }
149:         
150:         $result = $this->db
151:                 ->select('ea_users.id')
152:                 ->from('ea_users')
153:                 ->join('ea_roles', 'ea_roles.id = ea_users.id_roles', 'inner')
154:                 ->where('ea_users.email', $admin['email'])
155:                 ->where('ea_roles.slug', DB_SLUG_ADMIN)
156:                 ->get();
157:         
158:         if ($result->num_rows() == 0) {
159:             throw new Exception('Could not find admin record id.');
160:         }
161:         
162:         return intval($result->row()->id);
163:     }
164:     
165:     /**
166:      * Validate admin user data before add() operation is executed.
167:      * 
168:      * @param array $admin Contains the admin user data.
169:      * @return bool Returns the validation result.
170:      */
171:     public function validate($admin) {
172:         $this->load->helper('data_validation');
173:         
174:         try {
175:             // If a record id is provided then check whether the record exists in the database.
176:             if (isset($admin['id'])) {
177:                 $num_rows = $this->db->get_where('ea_users', array('id' => $admin['id']))
178:                         ->num_rows();
179:                 if ($num_rows == 0) {
180:                     throw new Exception('Given admin id does not exist in database: ' . $admin['id']);
181:                 }
182:             }
183:             
184:             // Validate required fields integrity.
185:             if (!isset($admin['last_name'])
186:                     || !isset($admin['email'])
187:                     || !isset($admin['phone_number'])) { 
188:                 throw new Exception('Not all required fields are provided : ' . print_r($admin, TRUE));
189:             }
190:             
191:             // Validate admin email address.
192:             if (!filter_var($admin['email'], FILTER_VALIDATE_EMAIL)) {
193:                 throw new Exception('Invalid email address provided : ' . $admin['email']);
194:             }
195:             
196:             return TRUE;
197:         } catch (Exception $exc) {
198:             return FALSE;
199:         }
200:     }
201:     
202:     /**
203:      * Delete an existing admin record from the database.
204:      * 
205:      * @param numeric $admin_id The admin record id to be deleted.
206:      * @return bool Returns the delete operation result.
207:      * @throws Exception When the $admin_id is not a valid numeric value.
208:      * @throws Exception When the record to be deleted is the only one admin user left on 
209:      * the system.
210:      */
211:     public function delete($admin_id) {
212:         if (!is_numeric($admin_id)) {
213:             throw new Exception('Invalid argument type $admin_id : ' . $admin_id);
214:         }
215:         
216:         // There must be always at least one admin user. If this is the only admin
217:         // the system, it cannot be deleted.
218:         $admin_count = $this->db->get_where('ea_users', 
219:                 array('id_roles' => $this->get_admin_role_id()))->num_rows();
220:         if ($admin_count == 1) {
221:             throw new Exception('Record could not be deleted. The system requires at least '
222:                     . 'one admin user.');
223:         }
224:         
225:         $num_rows = $this->db->get_where('ea_users', array('id' => $admin_id))->num_rows();
226:         if ($num_rows == 0) {
227:             return FALSE; // Record does not exist in database.
228:         }
229:         
230:         return $this->db->delete('ea_users', array('id' => $admin_id));
231:     }
232:     
233:     /**
234:      * Get a specific admin record from the database.
235:      * 
236:      * @param numeric $admin_id The id of the record to be returned.
237:      * @return array Returns an array with the admin user data.
238:      * @throws Exception When the $admin_id is not a valid numeric value.
239:      */
240:     public function get_row($admin_id) {
241:         if (!is_numeric($admin_id)) {
242:             throw new Exception('$admin_id argument is not a valid numeric value: ' . $admin_id);
243:         }
244: 
245:         // Check if record exists
246:         if ($this->db->get_where('ea_users', array('id' => $admin_id))->num_rows() == 0) {
247:             throw new Exception('The given admin id does not match a record in the database.');
248:         }
249:         
250:         $admin = $this->db->get_where('ea_users', array('id' => $admin_id))->row_array();
251:         
252:         $admin['settings'] = $this->db->get_where('ea_user_settings', 
253:                 array('id_users' => $admin_id))->row_array();
254:         unset($admin['settings']['id_users']);
255:         
256:         
257:         return $admin;
258:     }
259:     
260:     /**
261:      * Get a specific field value from the database.
262:      * 
263:      * @param string $field_name The field name of the value to be returned.
264:      * @param numeric $admin_id Record id of the value to be returned.
265:      * @return string Returns the selected record value from the database.
266:      * @throws Exception When the $field_name argument is not a valid string.
267:      * @throws Exception When the $admin_id is not a valid numeric.
268:      * @throws Exception When the admin record does not exist in the database.
269:      * @throws Exception When the selected field value is not present on database.
270:      */
271:     public function get_value($field_name, $admin_id) {
272:         if (!is_string($field_name)) {
273:             throw new Exception('$field_name argument is not a string : ' . $field_name);
274:         }
275:         
276:         if (!is_numeric($admin_id)) {
277:             throw new Exception('$admin_id argument is not a valid numeric value: ' . $admin_id);
278:         }
279:         
280:         // Check whether the admin record exists. 
281:         $result = $this->db->get_where('ea_users', array('id' => $admin_id));
282:         if ($result->num_rows() == 0) {
283:             throw new Exception('The record with the given id does not exist in the '
284:                     . 'database : ' . $admin_id);
285:         }
286:         
287:         // Check if the required field name exist in database.
288:         $provider = $result->row_array();
289:         if (!isset($provider[$field_name])) {
290:             throw new Exception('The given $field_name argument does not exist in the ' 
291:                     . 'database: ' . $field_name);
292:         }
293:         
294:         return $provider[$field_name];
295:     }
296:     
297:     /**
298:      * Get all, or specific admin records from database.
299:      * 
300:      * @param string|array $where_clause (OPTIONAL) The WHERE clause of the query to be executed. 
301:      * Use this to get specific admin records.
302:      * @return array Returns an array with admin records.
303:      */
304:     public function get_batch($where_clause = '') {
305:         $role_id = $this->get_admin_role_id();
306:         
307:         if ($where_clause != '') {
308:             $this->db->where($where_clause);
309:         }
310:         
311:         $batch = $this->db->get_where('ea_users', array('id_roles' => $role_id))->result_array();
312:         
313:         // Get every admin settings.
314:         foreach ($batch as &$admin) {
315:             $admin['settings'] = $this->db->get_where('ea_user_settings', 
316:                     array('id_users' => $admin['id']))->row_array();
317:             unset($admin['settings']['id_users']);
318:         }
319:         
320:         return $batch;
321:     }
322:     
323:     /**
324:      * Get the admin users role id. 
325:      * 
326:      * @return int Returns the role record id. 
327:      */
328:     public function get_admin_role_id() {
329:         return intval($this->db->get_where('ea_roles', array('slug' => DB_SLUG_ADMIN))->row()->id);
330:     }
331: }
332: 
333: /* End of file admins_model.php */
334: /* Location: ./application/models/admins_model.php */