Simple CRUD – CodeIgniter

A couple months ago i have developed PHP application. That’s was the first time (and the only one) i used CodeIgniter. The development itself only took a short period, thanks to helpful plugins and libraries such as excel_reader, jpgraph, dompdf and many more. At this moment, i want to share my humble knowledge in creating simple PHP application.

As the title suggest, we are going to create simple CRUD (Create Read Update Delete) application using CodeIgniter framework. The application that we are going to build is not a complex application (that’s why we call it “simple”) but consists of features such as pagination and simple validation.

Here, i’m using CodeIgniter_1.6.3 and MySql 5. Let’s begin.

1. Database schema. run this script.

   CREATE DATABASE crud;
   
   USE crud;
   CREATE TABLE tbl_person
   (
     id bigint auto_increment PRIMARY KEY,
     name varchar(50),
     gender char(1),
     dob date
   );
   
   INSERT tbl_person (name,gender,dob) VALUES('henrihnr', 'm', '1985-09-09');
   INSERT tbl_person (name,gender,dob) VALUES('name_001', 'm', '1990-01-01');
   INSERT tbl_person (name,gender,dob) VALUES('name_002', 'f', '2000-01-01');
   INSERT tbl_person (name,gender,dob) VALUES('name_003', 'm', '2000-02-02');
   INSERT tbl_person (name,gender,dob) VALUES('name_005', 'f', '2000-04-04');

2. Database configuration. file: CodeIgniter\system\application\config\database.php

   $active_group = "default";
   $active_record = TRUE;
   
   $db['default']['hostname'] = "localhost";
   $db['default']['username'] = "root";
   $db['default']['password'] = "";
   $db['default']['database'] = "crud";
   $db['default']['dbdriver'] = "mysql";

3. Base url configuration. file: CodeIgniter\system\application\config\config.php

   $config['base_url']	= "http://127.0.0.1/CodeIgniter/";

4. Default controller configuration. file: CodeIgniter\system\application\config\routes.php

   $route['default_controller'] = "person";

5. Model. create file CodeIgniter\system\application\models\personModel.php. Here we are using active record class.

   class PersonModel extends Model {
   	// table name
   	private $tbl_person= 'tbl_person';
   
   	function Person(){
   		parent::Model();
   	}
   	// get number of persons in database
   	function count_all(){
   		return $this->db->count_all($this->tbl_person);
   	}
   	// get persons with paging
   	function get_paged_list($limit = 10, $offset = 0){
   		$this->db->order_by('id','asc');
   		return $this->db->get($this->tbl_person, $limit, $offset);
   	}
   	// get person by id
   	function get_by_id($id){
   		$this->db->where('id', $id);
   		return $this->db->get($this->tbl_person);
   	}
   	// add new person
   	function save($person){
   		$this->db->insert($this->tbl_person, $person);
   		return $this->db->insert_id();
   	}
   	// update person by id
   	function update($id, $person){
   		$this->db->where('id', $id);
   		$this->db->update($this->tbl_person, $person);
   	}
   	// delete person by id
   	function delete($id){
   		$this->db->where('id', $id);
   		$this->db->delete($this->tbl_person);
   	}
   }

6. Controller. create file CodeIgniter\system\application\controllers\person.php

   <?php
   class Person extends Controller {
   
   	// num of records per page
   	private $limit = 10;
   	
   	function Person(){
   		parent::Controller();
   		
   		// load library
   		$this->load->library(array('table','validation'));
   		
   		// load helper
   		$this->load->helper('url');
   		
   		// load model
   		$this->load->model('personModel','',TRUE);
   	}
   	
   	function index($offset = 0){
   		// offset
   		$uri_segment = 3;
   		$offset = $this->uri->segment($uri_segment);
   		
   		// load data
   		$persons = $this->personModel->get_paged_list($this->limit, $offset)->result();
   		
   		// generate pagination
   		$this->load->library('pagination');
   		$config['base_url'] = site_url('person/index/');
    		$config['total_rows'] = $this->personModel->count_all();
    		$config['per_page'] = $this->limit;
   		$config['uri_segment'] = $uri_segment;
   		$this->pagination->initialize($config);
   		$data['pagination'] = $this->pagination->create_links();
   		
   		// generate table data
   		$this->load->library('table');
   		$this->table->set_empty("&nbsp;");
   		$this->table->set_heading('No', 'Name', 'Gender', 'Date of Birth (dd-mm-yyyy)', 'Actions');
   		$i = 0 + $offset;
   		foreach ($persons as $person){
   			$this->table->add_row(++$i, $person->name, strtoupper($person->gender)=='M'? 'Male':'Female', date('d-m-Y',strtotime($person->dob)), 
   				anchor('person/view/'.$person->id,'view',array('class'=>'view')).' '.
   				anchor('person/update/'.$person->id,'update',array('class'=>'update')).' '.
   				anchor('person/delete/'.$person->id,'delete',array('class'=>'delete','onclick'=>"return confirm('Are you sure want to delete this person?')"))
   			);
   		}
   		$data['table'] = $this->table->generate();
   		
   		// load view
   		$this->load->view('personList', $data);
   	}
   	
   	function add(){
   		// set validation properties
   		$this->_set_fields();
   		
   		// set common properties
   		$data['title'] = 'Add new person';
   		$data['message'] = '';
   		$data['action'] = site_url('person/addPerson');
   		$data['link_back'] = anchor('person/index/','Back to list of persons',array('class'=>'back'));
   	
   		// load view
   		$this->load->view('personEdit', $data);
   	}
   	
   	function addPerson(){
   		// set common properties
   		$data['title'] = 'Add new person';
   		$data['action'] = site_url('person/addPerson');
   		$data['link_back'] = anchor('person/index/','Back to list of persons',array('class'=>'back'));
   		
   		// set validation properties
   		$this->_set_fields();
   		$this->_set_rules();
   		
   		// run validation
   		if ($this->validation->run() == FALSE){
   			$data['message'] = '';
   		}else{
   			// save data
   			$person = array('name' => $this->input->post('name'),
   							'gender' => $this->input->post('gender'),
   							'dob' => date('Y-m-d', strtotime($this->input->post('dob'))));
   			$id = $this->personModel->save($person);
   			
   			// set form input name="id"
   			$this->validation->id = $id;
   			
   			// set user message
   			$data['message'] = '<div class="success">add new person success</div>';
   		}
   		
   		// load view
   		$this->load->view('personEdit', $data);
   	}
   	
   	function view($id){
   		// set common properties
   		$data['title'] = 'Person Details';
   		$data['link_back'] = anchor('person/index/','Back to list of persons',array('class'=>'back'));
   		
   		// get person details
   		$data['person'] = $this->personModel->get_by_id($id)->row();
   		
   		// load view
   		$this->load->view('personView', $data);
   	}
   	
   	function update($id){
   		// set validation properties
   		$this->_set_fields();
   		
   		// prefill form values
   		$person = $this->personModel->get_by_id($id)->row();
   		$this->validation->id = $id;
   		$this->validation->name = $person->name;
   		$_POST['gender'] = strtoupper($person->gender);
   		$this->validation->dob = date('d-m-Y',strtotime($person->dob));
   		
   		// set common properties
   		$data['title'] = 'Update person';
   		$data['message'] = '';
   		$data['action'] = site_url('person/updatePerson');
   		$data['link_back'] = anchor('person/index/','Back to list of persons',array('class'=>'back'));
   	
   		// load view
   		$this->load->view('personEdit', $data);
   	}
   	
   	function updatePerson(){
   		// set common properties
   		$data['title'] = 'Update person';
   		$data['action'] = site_url('person/updatePerson');
   		$data['link_back'] = anchor('person/index/','Back to list of persons',array('class'=>'back'));
   		
   		// set validation properties
   		$this->_set_fields();
   		$this->_set_rules();
   		
   		// run validation
   		if ($this->validation->run() == FALSE){
   			$data['message'] = '';
   		}else{
   			// save data
   			$id = $this->input->post('id');
   			$person = array('name' => $this->input->post('name'),
   							'gender' => $this->input->post('gender'),
   							'dob' => date('Y-m-d', strtotime($this->input->post('dob'))));
   			$this->personModel->update($id,$person);
   			
   			// set user message
   			$data['message'] = '<div class="success">update person success</div>';
   		}
   		
   		// load view
   		$this->load->view('personEdit', $data);
   	}
   	
   	function delete($id){
   		// delete person
   		$this->personModel->delete($id);
   		
   		// redirect to person list page
   		redirect('person/index/','refresh');
   	}
   	
   	// validation fields
   	function _set_fields(){
   		$fields['id'] = 'id';
   		$fields['name'] = 'name';
   		$fields['gender'] = 'gender';
   		$fields['dob'] = 'dob';
   		
   		$this->validation->set_fields($fields);
   	}
   	
   	// validation rules
   	function _set_rules(){
   		$rules['name'] = 'trim|required';
   		$rules['gender'] = 'trim|required';
   		$rules['dob'] = 'trim|required|callback_valid_date';
   		
   		$this->validation->set_rules($rules);
   		
   		$this->validation->set_message('required', '* required');
   		$this->validation->set_message('isset', '* required');
   		$this->validation->set_error_delimiters('<p class="error">', '</p>');
   	}
   	
   	// date_validation callback
   	function valid_date($str)
   	{
   		if(!ereg("^(0[1-9]|1[0-9]|2[0-9]|3[01])-(0[1-9]|1[012])-([0-9]{4})$", $str))
   		{
   			$this->validation->set_message('valid_date', 'date format is not valid. dd-mm-yyyy');
   			return false;
   		}
   		else
   		{
   			return true;
   		}
   	}
   }
   ?>

7. View. create 3 files at CodeIgniter\system\application\views folder. personList.php to list persons with pagination

   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   
   <title>SIMPLE CRUD APPLICATION</title>
   
   <link href="<?php echo base_url(); ?>style/style.css" rel="stylesheet" type="text/css" />
   
   </head>
   <body>
   	<div class="content">
   		<h1>Simple CRUD Application</h1>
   		<div class="paging"><?php echo $pagination; ?></div>
   		<div class="data"><?php echo $table; ?></div>
   		<br />
   		<?php echo anchor('person/add/','add new data',array('class'=>'add')); ?>
   	</div>
   </body>
   </html>

   personEdit.php to add or update a person

   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   
   <title>SIMPLE CRUD APPLICATION</title>
   
   <link href="<?php echo base_url(); ?>style/style.css" rel="stylesheet" type="text/css" />
   
   <link href="<?php echo base_url(); ?>style/calendar.css" rel="stylesheet" type="text/css" />
   <script type="text/javascript" src="<?php echo base_url(); ?>script/calendar.js"></script>
   
   </head>
   <body>
   	<div class="content">
   		<h1><?php echo $title; ?></h1>
   		<?php echo $message; ?>
   		<form method="post" action="<?php echo $action; ?>">
   		<div class="data">
   		<table>
   			<tr>
   				<td width="30%">ID</td>
   				<td><input type="text" name="id" disabled="disable" class="text" value="<?php echo $this->validation->id; ?>"/></td>
   				<input type="hidden" name="id" value="<?php echo $this->validation->id; ?>"/>
   			</tr>
   			<tr>
   				<td valign="top">Name<span style="color:red;">*</span></td>
   				<td><input type="text" name="name" class="text" value="<?php echo $this->validation->name; ?>"/>
   				<?php echo $this->validation->name_error; ?></td>
   			</tr>
   			<tr>
   				<td valign="top">Gender<span style="color:red;">*</span></td>
   				<td><input type="radio" name="gender" value="M" <?php echo $this->validation->set_radio('gender', 'M'); ?>/> M
   					<input type="radio" name="gender" value="F" <?php echo $this->validation->set_radio('gender', 'F'); ?>/> F
   					<?php echo $this->validation->gender_error; ?></td>
   			</tr>
   			<tr>
   				<td valign="top">Date of birth (dd-mm-yyyy)<span style="color:red;">*</span></td>
   				<td><input type="text" name="dob" onclick="displayDatePicker('dob');" class="text" value="<?php echo $this->validation->dob; ?>"/>
   				<a href="javascript:void(0);" onclick="displayDatePicker('dob');"><img src="<?php echo base_url(); ?>style/images/calendar.png" alt="calendar" border="0"></a>
   				<?php echo $this->validation->dob_error; ?></td>
   			</tr>
   			<tr>
   				<td>&nbsp;</td>
   				<td><input type="submit" value="Save"/></td>
   			</tr>
   		</table>
   		</div>
   		</form>
   		<br />
   		<?php echo $link_back; ?>
   	</div>
   </body>
   </html>

   personView.php to view a person details

   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   
   <title>SIMPLE CRUD APPLICATION</title>
   
   <link href="<?php echo base_url(); ?>style/style.css" rel="stylesheet" type="text/css" />
   
   </head>
   <body>
   	<div class="content">
   		<h1><?php echo $title; ?></h1>
   		<div class="data">
   		<table>
   			<tr>
   				<td width="30%">ID</td>
   				<td><?php echo $person->id; ?></td>
   			</tr>
   			<tr>
   				<td valign="top">Name</td>
   				<td><?php echo $person->name; ?></td>
   			</tr>
   			<tr>
   				<td valign="top">Gender</td>
   				<td><?php echo strtoupper($person->gender)=='M'? 'Male':'Female' ; ?></td>
   			</tr>
   			<tr>
   				<td valign="top">Date of birth (dd-mm-yyyy)</td>
   				<td><?php echo date('d-m-Y',strtotime($person->dob)); ?></td>
   			</tr>
   		</table>
   		</div>
   		<br />
   		<?php echo $link_back; ?>
   	</div>
   </body>
   </html>

8. Style. put stylesheet at CodeIgniter\style\style.css and style’s images at CodeIgniter\style\images folder
   

   body {
   	font-family:tahoma;
   	padding:0px;
   	margin:0px;
   	background:#f5f5f5
   }
   
   div.content {
   	padding:10px 20px;
   }
   div.content h1 {
   	font-size:18pt;
   	border-bottom:5px solid #a00;
   	padding:0px;
   	margin:10px 0px 20px;
   	width:80%;
   }
   
   div.content div.data table {
   	border:2px solid #000;
   	background:#fff;
   	width:80%;
   }
   div.content div.data table td {
   	font-size:10pt;
   	padding:5px 10px;
   	border-bottom:1px solid #ddd;
   	text-align: left;
   }
   div.content div.data table th {
   	text-align: left;
   	font-size: 8pt;
   	padding: 10px 10px 7px;
   	text-transform: uppercase;
   	color: #fff;
   	background:url(images/head.gif) left -5px repeat-x;
   }
   
   div.paging {
   	font-size: 9pt;
   	margin:5px 0px;
   }
   div.paging a {
   	color:#900;
   	text-transform: uppercase;
   	text-decoration: none;
   }
   div.paging a:hover {
   	color:#c00;
   }
   div.paging b {
   	color:#900;
   }
   
   div.success {
   	font-size:14pt;
   	background:url(images/accept.png) left 5px no-repeat;
   	padding:0px;
   	padding-left:20px;
   	margin:0px 0px 10px;
   	color:#060;
   	width:80%;
   }
   
   a.update, a.delete, a.add, a.view, a.back {
   	font-size: 9pt;
   	color:#900;
   	font-wight:bold;
   	padding-left:20px;
   	text-decoration: none;
   }
   a.update {
   	background:url(images/update.png) left center no-repeat;
   }
   a.delete {
   	background:url(images/delete.png) left center no-repeat;
   }
   a.add {
   	background:url(images/add.png) left center no-repeat;
   }
   a.view {
   	background:url(images/view.png) left center no-repeat;
   }
   a.back {
   	background:url(images/prev.gif) left center no-repeat;
   }
   a.update:hover, a.delete:hover, a.add:hover, a.view:hover {
   	color:#000;
   }
   
   input.text {
   	border:2px solid #aaa;
   }
   
   .error {
   	background: #FBE6F2 none repeat scroll 0 0;
   	border: 1px solid #D893A1;
   	color: #333333;
   	margin: 5px 0 0;
   	padding: 5px;
   	font-size: 10px;
   	font-family: Lucida Grande,Verdana,Geneva,Sans-serif;
   }

9. Script. put script at CodeIgniter\script folder
10. Done. Lets preview what should we have by now.

List of persons with pagination

Add new person

Update person

View person details

Error on validation

Download Simple CRUD Application. Happy Programming!!