summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/libraries/cart.rst
diff options
context:
space:
mode:
authorAhmad Anbar <aanbar@gmail.com>2015-02-04 18:20:01 +0100
committerAhmad Anbar <aanbar@gmail.com>2015-02-04 18:20:01 +0100
commite5454f9b28f123a5549971f580255a065b2f8cc2 (patch)
treec4927e7b7afb0bf242976034630cc60f2f1db00f /user_guide_src/source/libraries/cart.rst
parent6db62ab0ad0e223806a1367e12b1884b48dc65d7 (diff)
parenteccac6e6a73a4d1a5b40f383ce64359c2c94ae12 (diff)
Merge remote-tracking branch 'upstream/develop' into develop
Diffstat (limited to 'user_guide_src/source/libraries/cart.rst')
-rw-r--r--user_guide_src/source/libraries/cart.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index a023ccb36..be343320d 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -7,7 +7,7 @@ while a user is browsing your site. These items can be retrieved and
displayed in a standard "shopping cart" format, allowing the user to
update the quantity or remove items from the cart.
-.. important:: The Card library is DEPRECATED and should not be used.
+.. important:: The Cart library is DEPRECATED and should not be used.
It is currently only kept for backwards compatibility.
Please note that the Cart Class ONLY provides the core "cart"
@@ -285,7 +285,7 @@ the update form is submitted. Please examine the construction of the
Class Reference
***************
-.. class:: CI_Cart
+.. php:class:: CI_Cart
.. attribute:: $product_id_rules = '\.a-z0-9_-'
@@ -302,7 +302,7 @@ Class Reference
Whether or not to only allow safe product names. Default TRUE.
- .. method:: insert([$items = array()])
+ .. php:method:: insert([$items = array()])
:param array $items: Items to insert into the cart
:returns: TRUE on success, FALSE on failure
@@ -312,7 +312,7 @@ Class Reference
on success and FALSE on failure.
- .. method:: update([$items = array()])
+ .. php:method:: update([$items = array()])
:param array $items: Items to update in the cart
:returns: TRUE on success, FALSE on failure
@@ -323,7 +323,7 @@ Class Reference
to the quantity before checkout. That array must contain the rowid
for each item.
- .. method:: remove($rowid)
+ .. php:method:: remove($rowid)
:param int $rowid: ID of the item to remove from the cart
:returns: TRUE on success, FALSE on failure
@@ -332,7 +332,7 @@ Class Reference
Allows you to remove an item from the shopping cart by passing it the
``$rowid``.
- .. method:: total()
+ .. php:method:: total()
:returns: Total amount
:rtype: int
@@ -340,7 +340,7 @@ Class Reference
Displays the total amount in the cart.
- .. method:: total_items()
+ .. php:method:: total_items()
:returns: Total amount of items in the cart
:rtype: int
@@ -348,7 +348,7 @@ Class Reference
Displays the total number of items in the cart.
- .. method:: contents([$newest_first = FALSE])
+ .. php:method:: contents([$newest_first = FALSE])
:param bool $newest_first: Whether to order the array with newest items first
:returns: An array of cart contents
@@ -359,7 +359,7 @@ Class Reference
will be sorted from newest to oldest, otherwise it is sorted from oldest
to newest.
- .. method:: get_item($row_id)
+ .. php:method:: get_item($row_id)
:param int $row_id: Row ID to retrieve
:returns: Array of item data
@@ -368,7 +368,7 @@ Class Reference
Returns an array containing data for the item matching the specified row
ID, or FALSE if no such item exists.
- .. method:: has_options($row_id = '')
+ .. php:method:: has_options($row_id = '')
:param int $row_id: Row ID to inspect
:returns: TRUE if options exist, FALSE otherwise
@@ -379,7 +379,7 @@ Class Reference
you must pass the rowid to this method, as shown in the Displaying
the Cart example above.
- .. method:: product_options([$row_id = ''])
+ .. php:method:: product_options([$row_id = ''])
:param int $row_id: Row ID
:returns: Array of product options
@@ -390,7 +390,7 @@ Class Reference
must pass the rowid to this method, as shown in the Displaying the
Cart example above.
- .. method:: destroy()
+ .. php:method:: destroy()
:rtype: void