How To Build A Shopping Cart Using CodeIgniter and JQuery
How To Build A Shopping Cart Using CodeIgniter and JQuery
Tutorial Details
Topic:CodeIgniter, jQuery
Difficulty: Intermediate
Estimated Completion Time: 30 minutes
CodeIgniter is an open source PHP web application framework with a lot of features. Recently,
thanks to the latest update, a new feature was added to this framework, called the Cart Class. In
this tutorial, were going to take advantage of this new class, and write a shopping cart system,
with a touch of jQuery added in.
Folder Structure
Before we start coding, I would like to create a solid structure for our application. I prefer to
move the application folder out of the system folder; this is not required, but
it makes the update process easier in the future.
The final folder we need to create before beginning is the assets folder; this is where I store my
images, Javascript, CSS and other assets.
Lets take a look at the final folder structure:
Inside the folder assets/js, we place our jquery-1.3.2.min.js file, and an empty file called
core.js. In this file, we will write our JavaScript.
And one more thing remains: we need to create our stylesheet. So create a new file in
assets/css called core.css.
Database
We are going to retrieve our products from the database; so lets go to PHPMyAdmin and create
a table called CI_Cart.
And for those of you who want to copy and paste, the SQL Code
Theres everything that needs to be done for our database in this tutorial.
Step 1: Application Config
Before we can start using CodeIgniter, we have to setup our configuration. Open
application/config/config.php, and change the following:
1. $config['base_url'] = "http://example.com";
Replace http://example.com with the url to your installation. Next, look for Global XSS
Filtering located near the bottom of the config.php file.
1. $config['global_xss_filtering'] = FALSE;
Lets change FALSE to TRUE, in order to make this filter active when GET, POST or COOKIE
data is encountered. Next, open application/config/database.php and
enter your database information.
1. $db['default']['hostname'] = "localhost";
2. $db['default']['username'] = "root";
3. $db['default']['password'] = "root";
4. $db['default']['database'] = "CI_Cart";
5. $db['default']['dbdriver'] = "mysql";
1. $route['default_controller'] = "cart";
Now when someone visits the url to your application, the cart class will be loaded automatically.
We have one more file to edit, so open application/config/autoload.php and autoload the
following components:
1. /*
2. | -------------------------------------------------------------------
3. | Auto-load Libraries
4. | -------------------------------------------------------------------
5. | These are the classes located in the system/libraries folder
6. | or in your system/application/libraries folder.
7. |
8. | Prototype:
9. |
10. | $autoload['libraries'] = array('database', 'session', 'xmlrpc');
11. */
12.
13. $autoload['libraries'] = array('cart', 'database');
14.
15.
16. /*
17. | -------------------------------------------------------------------
18. | Auto-load Helper Files
19. | -------------------------------------------------------------------
20. | Prototype:
21. |
22. | $autoload['helper'] = array('url', 'file');
23. */
24.
25. $autoload['helper'] = array('url', 'form');
Libraries
database Allows your application to connect with a database and makes the database
class available.
cart Allows you to access the shopping cart class, more information.
Helpers
url The url library allows you to access different methods to create and retrieve links,
more information
form This library helps us with creating form. For more information
1. <?php
2.
3. class Cart extends Controller { // Our Cart class extends the Controller class
4.
5. function Cart()
6. {
7. parent::Controller(); // We define the the Controller class is the parent.
8. }
9.
10.
11. }
12. /* End of file cart.php */
13. /* Location: ./application/controllers/cart.php */
Now, lets create our index function. This will run automatically when the class cart is requested.
1. function index()
2. {
3. $data['products'] = $this->cart_model-
>retrieve_products(); // Retrieve an array with all products
4. }
So what happens here? Well you will notice that we assigned the output of our cart_model to a
variable called $data['products'].
If we refresh our page, we will get an error, because we havent made our cart_model yet.
Models are PHP classes that are designed to work with information in your database. For
example, lets say you use CodeIgniter to manage a blog. You might have a
model class that contains functions to insert, update, and retrieve your blog data.
Models are created in the following folder: application/models/; so lets create our model file
called cart_model.php, and make a few edits.
1. <?php
2.
3. class Cart_model extends Model { // Our Cart_model class extends the Model class
4.
5. }
6.
7. /* End of file cart_model.php */
8. /* Location: ./application/models/cart_model.php */
Its as simple as that; we have created our model. Its important that you extend your
Cart_model with Model in order to make it work properly. Remember when we called our
model in the index() function of our cart controller? We called a function called
retrieve_products, so lets create that!
1. <?php
2.
3. class Cart_model extends Model { // Our Cart_model class extends the Model class
4.
5. // Function to retrieve an array with all product information
6. function retrieve_products(){
7. $query = $this->db->get('products'); // Select the table products
8. return $query->result_array(); // Return the results in a array.
9. }
10.
11. }
12.
13. /* End of file cart_model.php */
14. /* Location: ./application/models/cart_model.php */
We created our model, and called the function retrieve_products from our cart controller, but we
forgot to load it.
There are different methods on how to load a model, but in this tutorial Im going to call it in the
construct function, or in this case, the cart function located at
the top of our controllers/cart.php file.
1. <?php
2.
3. class Cart extends Controller { // Our Cart class extends the Controller class
4.
5. function Cart()
6. {
7. parent::Controller(); // We define the the Controller class is the parent.
8. $this->load->model('cart_model'); // Load our cart model for our entire class
9. }
10.
11. }
12. /* End of file cart.php */
13. /* Location: ./application/controllers/cart.php */
1. function index()
2. {
3. $data['products'] = $this->cart_model-
>retrieve_products(); // Retrieve an array with all products
4. print_r($data['products']); // Print out the array to see if it works (Remove this line whe
n done testing)
5. }
If everything processed correct, you should see the following in your browser.
Array ( [0] => Array ( [id] => 1 [name] => MacBook Pro [price]
=> 1199 [image] => macbookpro.jpg )
[1] => Array ( [id] => 2 [name] => MacBook Air [price]
=> 1499 [image] => macbookair.jpg )
[2] => Array ( [id] => 3 [name] => MacBook [price] =>
999 [image] => macbook.jpg ) )
Now that we have retrieved our content, we have to display it using a view!
A view is simply a web page, or a page fragment, like a header, footer, sidebar, etc.
In fact, views can flexibly be embedded within other views (within other views, etc., etc.) if you
need this type of hierarchy.
Views are never called directly, they must be loaded by a controller.
Remember that in an MVC framework, the Controller acts as the traffic cop, so it is responsible
for fetching a particular view.
Open the folder application/views, and create a new file called index.php.
This is going to be our core template. As you can see, we load our jQuery and our stylesheet.
Because we loaded the url helper, base_url(); will return the url to our application.
We are also loading a view that contains a variable called $content. This allows us to
dynamically load content. If we define that $content is demo, the view
views/demo.php will be loaded for example.
1. function index()
2. {
3. $data['products'] = $this->cart_model-
>retrieve_products(); // Retrieve an array with all products
4.
5. $data['content'] = 'cart/products'; // Select our view file that will display our products
6. $this->load->view('index', $data); // Display the page with the above defined content
7. }
As you can see, we have set the variable $content to cart/products. We havent made this view
yet, so lets do that now.
Create a new file in application/views/cart and call it products.php. Within this file, well
display the data that we received from our cart model. We are going to
use an unsorted list to display our products.
1. <ul class="products">
2. <li></li>
3. </ul>
Because the product data is being returned in a array, we have to use foreach in order to display
all products
1. <ul class="products">
2. <?php foreach($products as $p): ?>
3. <li>
4. </li>
5. <?php endforeach;?>
6. </ul>
Now that weve started a foreach loop, we can start displaying the product data.
1. <ul class="products">
2. <?php foreach($products as $p): ?>
3. <li>
4. <h3><?php echo $p['name']; ?></h3>
5. <img src="<?php echo base_url(); ?>assets/img/products/<?php echo $p['image']; ?
>" alt="" />
6. <small>€<?php echo $p['price']; ?></small>
7. <?php echo form_open('cart/add_cart_item'); ?>
8. <fieldset>
9. <label>Quantity</label>
10. <?php echo form_input('quantity', '1', 'maxlength="2"'); ?>
11. <?php echo form_hidden('product_id', $p['id']); ?>
12. <?php echo form_submit('add', 'Add'); ?>
13. </fieldset>
14. <?php echo form_close(); ?>
15. </li>
16. <?php endforeach;?>
17. </ul>
Here, we use the base_url function to retrieve the url to our application, and then access the
folder assets/img.
Then we request the product image from the database.
We display the product price retrieved from the database, and wrapp it within small tags.
1. <label>Quantity</label>
2. <?php echo form_input('quantity', '1', 'maxlength="2"'); ?>
3. <?php echo form_hidden('product_id', $p['id']); ?>
4. <?php echo form_submit('add', 'Add'); ?>
This is the part where the user can define the quantity of items he/she wants. We use the form
helper again to create an input field with the name quantity and set the default value to 1.
We also pass through some extra data in this case, we set the maxlength to 2.
We also placed a hidden field again using the form helper and named it product_id.
Next, we have the submit button, with the name add and the default value Add.
1. </fieldset>
2. lt;?php echo form_close(); ?>
Finally, we close our fieldset, and the form. Now lets add some CSS!
1. body{
2. font-family: "Lucida Sans";
3. font-size: 12px;
4. }
5.
6. #wrap{
7. width: 1024px;
8. }
9.
10. ul.products{
11. list-style-type: none;
12. width: 525px;
13. margin: 0;
14. padding: 0;
15. }
16.
17. ul.products li{
18. background: #eeeeee;
19. border: 1px solid #d3d3d3;
20. padding: 5px;
21. width: 150px;
22. text-align: center;
23. float: left;
24. margin-right: 10px;
25. }
26.
27. ul.products h3{
28. margin: 0;
29. padding: 0px 0px 5px 0px;
30. font-size: 14px;
31. }
32.
33. ul.products small{
34. display: block;
35. }
36.
37. ul.products form fieldset{
38. border: 0px;
39. }
40.
41. ul.products form label{
42. font-size: 12px;
43. }
44.
45. ul.products form input[type=text]{
46. width: 18px;
47. background: #FFF;
48. border: 1px solid #d3d3d3;
49. }
Ive added three images to assets/img/products, which correspond to the names from the
database.
1. $(document).ready(function() {
2. /*place jQuery actions here*/
3.
4. });
Because CodeIgniter uses a mod_rewrite kind of url index.php/cart, we are going to define a
var with the url to our application:
1. $(document).ready(function() {
2. /*place jQuery actions here*/
3. var link = "/tutorials/CodeIgniter_Shopping_Cart/demo/index.php/"; // Url to your appl
ication (including index.php/)
4.
5. });
Dont forget to change it accordingly to your situation. Next, we want to see if any form is being
submitted. We can use the jQuery submit function to do just that.
1. $(document).ready(function() {
2. /*place jQuery actions here*/
3. var link = "/tutorials/CodeIgniter_Shopping_Cart/demo/index.php/"; // Url to your appl
ication (including index.php/)
4.
5. $("ul.products form").submit(function() {
6.
7. return false; // Stop the browser of loading the page defined in the form "action" para
meter.
8. });
9.
10. });
Before we can send the data using jQuery, we have to get the values that we have to send. So we
use the jQuery find function to find the fields we need, and retrieve their values.
If youd like to test it out, add an alert and lets see what happens.
1. $(document).ready(function() {
2. /*place jQuery actions here*/
3. var link = "/tutorials/CodeIgniter_Shopping_Cart/demo/index.php/"; // Url to your appl
ication (including index.php/)
4.
5. $("ul.products form").submit(function() {
6. // Get the product ID and the quantity
7. var id = $(this).find('input[name=product_id]').val();
8. var qty = $(this).find('input[name=quantity]').val();
9.
10. alert('ID:' + id + '\n\rQTY:' + qty);
11.
12. return false; // Stop the browser of loading the page defined in the form "action" para
meter.
13. });
14.
15. });
So that works fine! This means we can start sending these values using jQuery Post.
1. $(document).ready(function() {
2. /*place jQuery actions here*/
3. var link = "/tutorials/CodeIgniter_Shopping_Cart/demo/index.php/"; // Url to your appl
ication (including index.php/)
4.
5. $("ul.products form").submit(function() {
6. // Get the product ID and the quantity
7. var id = $(this).find('input[name=product_id]').val();
8. var qty = $(this).find('input[name=quantity]').val();
9.
10. $.post(link + "cart/add_cart_item", { product_id: id, quantity: qty, ajax: '1' },
11. function(data){
12. // Interact with returned data
13. });
14.
15. return false; // Stop the browser of loading the page defined in the form "action" para
meter.
16. });
17.
18. });
In the code above, we post data to our cart controller and request the function add_cart_item.
This an example of the posted data:
product_id: 3
quantity: 1
ajax: 1
Besides the product data, you can see that we also send through a variable called ajax, with the
value 1. We can use this to check if the user has JavaScript enabled
or not. Because when its disabled, only the product_id and the quantity will be posted.
Before we can start interacting with the data returned from our post, we have to create the
function that returns the data. Open
application/controllers/cart.php and add a function named add_cart_item
1. function add_cart_item(){
2.
3. if($this->cart_model->validate_add_cart_item() == TRUE){
4.
5. // Check if user has javascript enabled
6. if($this->input->post('ajax') != '1'){
7. redirect('cart'); // If javascript is not enabled, reload the page with new data
8. }else{
9. echo 'true'; // If javascript is enabled, return true, so the cart gets updated
10. }
11. }
12.
13. }
In the code above, we start our function add_cart_item. Next, we use an if statment to check if
the cart_model function called validate_add_cart_item()
returns true. We still have to create that function, but what this does in the end, is check if the
product exists, and then adds it to the cart. Well go over this a bit more shortly.
You can now see why weve added the ajax value in the jQuery Post. If no ajax is posted, it
means the user has disabled JavaScript which means we must reload the page
so that the user sees a refreshed cart. If ajax is posted, we return the value true, so jQuery knows
that everything processed correctly.
Now, its time to validate the posted data, and see if the product exists.
9.
10. }
We create a query, and request to return 1 result where the posted id matches the id within
the database.
9.
10. // Check if a row has matched our product id
11. if($query->num_rows > 0){
12.
13. // We have a match!
14.
15. }else{
16. // Nothing found! Return FALSE!
17. return FALSE;
18. }
19. }
If nothing is found, we return false. If a match is found, we add the item to cart.
9.
10. // Check if a row has matched our product id
11. if($query->num_rows > 0){
12.
13. // We have a match!
14. foreach ($query->result() as $row)
15. {
16. // Create an array with product information
17. $data = array(
18. 'id' => $id,
19. 'qty' => $cty,
20. 'price' => $row->price,
21. 'name' => $row->name
22. );
23.
24. // Add the data to the cart using the insert function that is available because we loa
ded the cart library
25. $this->cart->insert($data);
26.
27. return TRUE; // Finally return TRUE
28. }
29.
30. }else{
31. // Nothing found! Return FALSE!
32. return FALSE;
33. }
34. }
Before we can use jQuery to reload the cart, we have to create the cart list.
1. <div id="wrap">
2.
3. <?php $this->view($content); ?>
4.
5. <div class="cart_list">
6. <h3>Your shopping cart</h3>
7. <div id="cart_content">
8. <?php echo $this->view('cart/cart.php'); ?>
9. </div>
10. </div>
11. </div>
Above, we created a div called cart_list, and, inside, a div with the id cart_content. Now
inside the div cart_content, we are going to load another view
called cart.php.
Create a new file in application/views/cart/, and name it cart.php. Add the following
code:
1. <?php if(!$this->cart->contents()):
2. echo 'You don\'t have any items yet.';
3. else:
4. ?>
5.
6. <?php echo form_open('cart/update_cart'); ?>
7. <table width="100%" cellpadding="0" cellspacing="0">
8. <thead>
9. <tr>
10. <td>Qty</td>
11. <td>Item Description</td>
12. <td>Item Price</td>
13. <td>Sub-Total</td>
14. </tr>
15. </thead>
16. <tbody>
17. <?php $i = 1; ?>
18. <?php foreach($this->cart->contents() as $items): ?>
19.
20. <?php echo form_hidden('rowid[]', $items['rowid']); ?>
21. <tr <?php if($i&1){ echo 'class="alt"'; }?>>
22. <td>
23. <?php echo form_input(array('name' => 'qty[]', 'value' => $items['qty'], 'maxlen
gth' => '3', 'size' => '5')); ?>
24. </td>
25.
26. <td><?php echo $items['name']; ?></td>
27.
28. <td>€<?php echo $this->cart->format_number($items['price']); ?></td>
29. <td>€<?php echo $this->cart->format_number($items['subtotal']); ?></td>
30. </tr>
31.
32. <?php $i++; ?>
33. <?php endforeach; ?>
34.
35. <tr>
36. <td</td>
37. <td></td>
38. <td><strong>Total</strong></td>
39. <td>€<?php echo $this->cart->format_number($this->cart-
>total()); ?></td>
40. </tr>
41. </tbody>
42. </table>
43.
44. <p><?php echo form_submit('', 'Update your Cart'); echo anchor('cart/empty_cart', 'Empt
y Cart', 'class="empty"');?></p>
45. <p><small>If the quantity is set to zero, the item will be removed from the cart.</small>
</p>
46. <?php
47. echo form_close();
48. endif;
49. ?>
Thats quite some code; lets break it down into different parts.
1. <?php if(!$this->cart->contents()):
2. echo 'You don\'t have any items yet.';
3. else:
4. ?>
We use an if statment to check if the cart contains any content. If the cart does not have any
content, we display the message You dont have any items yet. If
the cart is not empty, we will run the rest of the code.
Next, we create our form open tag using the form helper, and set the action parameter to
cart/update_cart. We also created a table with a tableheading, and
added the Quantity, Item Description, Item Price, and Sub-Total fields.
1. <tbody>
2. <?php $i = 1; // Keep track of the amount of loops ?>
3. <?php foreach($this->cart-
>contents() as $items): // We break the cart contents into parts ?>
4.
5. <?php echo form_hidden('rowid[]', $items['rowid']); // We added an hidden field which
contains a unique id in array format, this is needed in order to update ?>
6. <tr <?php if($i&1){ echo 'class="alt"'; // If $i is odd, we add the class "alt" in order to c
hange the background color }?>>
7. <td>
8. <?php echo form_input(array('name' => 'qty[]', 'value' => $items['qty'], 'maxlengt
h' => '3', 'size' => '5')); // Here we created an input field with the name qty[] this allows us
to interact with it as an array when its posted.?>
9. </td>
10.
11. <td><?php echo $items['name']; // Display the item name ?></td>
12.
13. <td>€<?php echo $this->cart-
>format_number($items['price']); // Display the item price ?></td>
14. <td>€<?php echo $this->cart-
>format_number($items['subtotal']); // Display subtotal ?></td>
15. </tr>
16.
17. <?php $i++; // Add 1 to $i ?>
18. <?php endforeach; // End the foreach ?>
19.
20. <tr>
21. <td</td>
22. <td></td>
23. <td><strong>Total</strong></td>
24. <td>€<?php echo $this->cart->format_number($this->cart-
>total()); // Display the total amount ?></td>
25. </tr>
26. </tbody>
The row ID is a unique identifier that is generated by the cart code when an item is added to the
cart.
The reason a unique ID is created is so that identical products with different options can be
managed by the cart.
For example, lets imagine that someone buys two identical t-shirts (same product ID), but in
different sizes. The product ID (and other attributes) will
be identical for both sizes because its the same shirt. The only difference will be the size. The
cart must therefore have a means of identifying
this difference so that the two sizes of shirts can be managed independently. It does so by
creating a unique row ID based on the product ID and
any options associated with it.
1. </table>
2.
3. <p><?php echo form_submit('', 'Update your Cart'); echo anchor('cart/empty_cart', 'Empt
y Cart', 'class="empty"');?></p>
4. <p><small>If the quantity is set to zero, the item will be removed from the cart.</small>
</p>
5. <?php
6. echo form_close();
7. endif;
8. ?>
Finally, we close the table and create a link using the anchor function to cart/emtpy_cart. We
will create the empty cart
function shortly.
As you can see, jQuery posts the data to cart/add_cart_item; now lets see what the response
is.
TRUE is returned, so refresh your page, and you should have an item in your shopping cart.
Now that this works, lets move on with jQuery, and refresh the cart when an item is added to the
cart.
1. $(document).ready(function() {
2. /*place jQuery actions here*/
3. var link = "/tutorials/CodeIgniter_Shopping_Cart/demo/index.php/"; // Url to your appl
ication (including index.php/)
4.
5. $("ul.products form").submit(function() {
6. // Get the product ID and the quantity
7. var id = $(this).find('input[name=product_id]').val();
8. var qty = $(this).find('input[name=quantity]').val();
9.
10. $.post(link + "cart/add_cart_item", { product_id: id, quantity: qty, ajax: '1' },
11. function(data){
12. // Interact with returned data
13. });
14.
15. return false; // Stop the browser of loading the page defined in the form "action" para
meter.
16. });
17.
18. });
Now its time to interact with the returned data, in this case true or false.
By using an if statment, we can refresh the cart if true is returned, or give an alert when the
product the user is trying to add does not exist.
When true has been returned, we use jQuerys get, to load the url cart/show_cart, and we
replace the div #cart_content with data returned by that url.
But, you might notice that the function show_cart does not exist yet; lets create that now by
opening our controller application/controllers/cart.php
This is a very easy solution. We just have to return the contents of the cart, create the function,
and return the view views/cart/cart.php
1. function show_cart(){
2. $this->load->view('cart/cart');
3. }
Refresh the page, and try to add another item. jQuery should add it without reloading the page.
(Unless you have JavaScript disabled, of course.)
As you can see, the rowid is unique for every item in the shopping cart. Were going to use these
ids to check which item must be updated.
1. function update_cart(){
2. $this->cart_model->validate_update_cart();
3. redirect('cart');
4. }
Again, we use a model to handle the data. After thats done, we refresh the users page. Open
application/models/cart_model.php, and create a new
function called validate_update_cart.
As you can see, we first assign the total amount of items in our cart to a local variable called
$total.
Next, we assign the posted rowids and quantities to local variables as well.
We use for to cycle through all items until $i equals $total this makes sure all items are
updated.
When cycling through the posted items, we create an array with the posted rowid and the
quantity. When the array is created, we update this information using
the cart library function called update.
1. function empty_cart(){
2. $this->cart->destroy(); // Destroy all cart data
3. redirect('cart'); // Refresh te page
4. }
Add some jQuery to that! Open assets/js/core.js and write the following:
1. $(".empty").live("click", function(){
2. $.get(link + "cart/empty_cart", function(){
3. $.get(link + "cart/show_cart", function(cart){
4. $("#cart_content").html(cart);
5. });
6. });
7.
8. return false;
9. });
Our Emtpy Cart link has a class called .empty; so we attach a click function to it with no
problems. You might notice that we are using the jQuery live function.
We have to use this in order to make it work. If we left it out, and you add an item to the cart,
and then press empty cart, it wont work.
After the link is clicked, we use the same code that is in the update cart function. First, we fetch
the empty_cart url so our cart will be empty, and then we simply fetch the new cart content, and
place that content into our #cart_content div.
Done!