Update Cart lib docs

1 files changed, 105 insertions, 47 deletions

diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 716e94bcb..ad1955d27 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -11,7 +11,16 @@ Please note that the Cart Class ONLY provides the core "cart"
 functionality. It does not provide shipping, credit card authorization,
 or other processing components.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+********************
+Using the Cart Class
+********************
 
 Initializing the Shopping Cart Class
 ====================================
@@ -29,7 +38,7 @@ use the $this->load->library function::
 	$this->load->library('cart');
 
 Once loaded, the Cart object will be available using::
- 	
+
 	$this->cart
 
 .. note:: The Cart Class will load and initialize the Session Class
@@ -179,7 +188,7 @@ helper </helpers/form_helper>`.
 	</table>
 
 	<p><?php echo form_submit('', 'Update your Cart'); ?></p>
-	
+
 Updating The Cart
 =================
 
@@ -197,7 +206,7 @@ function:
 	               'qty'   => 3
 	            );
 
-	$this->cart->update($data); 
+	$this->cart->update($data);
 
 	// Or a multi-dimensional array
 
@@ -243,66 +252,115 @@ update form is submitted. Please examine the construction of the "view
 cart" page above for more information.
 
 
-Function Reference
-==================
+***************
+Class Reference
+***************
+
+.. class:: CI_Cart
+
+	.. attribute:: $product_id_rules = '\.a-z0-9_-'
+
+		These are the regular expression rules that we use to validate the product
+		ID - alpha-numeric, dashes, underscores, or periods by default
+
+	.. attribute:: $product_name_rules	= '\w \-\.\:'
+
+		These are the regular expression rules that we use to validate the product ID and product name - alpha-numeric, dashes, underscores, colons or periods by
+		default
+
+	.. attribute:: $product_name_safe = TRUE
+
+		Whether or not to only allow safe product names. Default TRUE.
+
+
+	.. method:: insert([$items = array()])
+
+		:param array $items: the items to insert into the cart
+		:returns: bool
+
+		Insert items into the cart and save it to the session table. Returns TRUE
+		on success and FALSE on failure.
+
+
+	.. method:: update([$items = array()])
+
+		:param array $items: the items to update in the cart
+		:returns: bool
+
+		This method permits the quantity of a given item to be changed.
+		Typically it is called from the "view cart" page if a user makes changes
+		to the quantity before checkout. That array must contain the product ID
+		and quantity for each item.
+
+
+	.. method:: remove($rowid)
+
+		:param int $rowid: the ID of the item to remove from the cart
+		:returns: bool
+
+		Allows you to remove an item from the shopping cart by passing it the
+		``$rowid``.
+
+
+	.. method:: total()
+
+		:returns: int
+
+		Displays the total amount in the cart.
+
+
+	.. method:: total_items()
+
+		:returns: int
+
+		Displays the total number of items in the cart.
 
-$this->cart->insert();
-**********************
 
-Permits you to add items to the shopping cart, as outlined above.
+	.. method:: contents([$newest_first = FALSE])
 
-$this->cart->update();
-**********************
+		:param bool $newest_first: order the array with newest first?
+		:returns: array
 
-Permits you to update items in the shopping cart, as outlined above.
+		Returns an array containing everything in the cart. You can sort the
+		order by which the array is returned by passing it TRUE where the contents
+		will be sorted from newest to oldest, otherwise it is sorted from oldest
+		to newest.
 
-$this->cart->remove(rowid);
-***************************
 
-Allows you to remove an item from the shopping cart by passing it the rowid.
+	.. method:: get_item($row_id)
 
-$this->cart->total();
-*********************
+		:param int $row_id: the row ID to retrieve
+		:returns: array
 
-Displays the total amount in the cart.
+		Returns an array containing data for the item matching the specified row
+		ID, or FALSE if no such item exists.
 
-$this->cart->total_items();
-***************************
 
-Displays the total number of items in the cart.
+	.. method:: has_options($row_id = '')
 
-$this->cart->contents(boolean);
-*******************************
+		:param int $row_id: the row ID to inspect
+		:returns: bool
 
-Returns an array containing everything in the cart. You can sort the order,
-by which this is returned by passing it "true" where the contents will be sorted
-from newest to oldest, by leaving this function blank, you'll automatically just get
-first added to the basket to last added to the basket.
+		Returns TRUE (boolean) if a particular row in the cart contains options.
+		This method is designed to be used in a loop with :meth:contents:, since
+		you must pass the rowid to this function, as shown in the Displaying
+		the Cart example above.
 
-$this->cart->get_item($row_id);
-*******************************
 
-Returns an array containing data for the item matching the specified row ID,
-or FALSE if no such item exists.
+	.. method:: product_options([$row_id = ''])
 
-$this->cart->has_options($row_id);
-**********************************
+		:param int $row_id: the row ID
+		:returns: array
 
-Returns TRUE (boolean) if a particular row in the cart contains options.
-This function is designed to be used in a loop with
-$this->cart->contents(), since you must pass the rowid to this function,
-as shown in the Displaying the Cart example above.
+		Returns an array of options for a particular product. This method is
+		designed to be used in a loop with :meth:contents:, since you
+		must pass the rowid to this method, as shown in the Displaying the
+		Cart example above.
 
-$this->cart->product_options($row_id);
-**************************************
 
-Returns an array of options for a particular product. This function is
-designed to be used in a loop with $this->cart->contents(), since you
-must pass the rowid to this function, as shown in the Displaying the
-Cart example above.
+	.. method:: destroy()
 
-$this->cart->destroy();
-***********************
+		:returns: void
 
-Permits you to destroy the cart. This function will likely be called
-when you are finished processing the customer's order.
+		Permits you to destroy the cart. This method will likely be called
+		when you are finished processing the customer's order.
\ No newline at end of file