summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2014-02-13 12:56:50 +0100
committerAndrey Andreev <narf@devilix.net>2014-02-13 12:56:50 +0100
commit42a1139debbe1679beb670dd29561a2965f99b8c (patch)
tree5a82d069aed0e87e0110ad9a2c25e73b5e314cc2 /user_guide_src
parent376b215500b1facb3ba063aec618bcc12da50351 (diff)
parentc09b953be9d14158cc21cecc676f7e992c16f752 (diff)
Merge pull request #2874 from aanbar/develop
[Cart Library] Allow updating all properties for an item.
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/changelog.rst1
-rw-r--r--user_guide_src/source/libraries/cart.rst35
2 files changed, 32 insertions, 4 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 16c30b795..c8cbbb9e5 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -308,6 +308,7 @@ Release Date: Not Released
- Added method ``remove()`` to remove a cart item, updating with quantity of 0 seemed like a hack but has remained to retain compatibility.
- Added method ``get_item()`` to enable retrieving data for a single cart item.
- Added unicode support for product names.
+ - ``update()`` now supports updating all properties attached to an item.
- :doc:`Image Manipulation Library <libraries/image_lib>` changes include:
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index fb92c280a..74e791554 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -88,6 +88,18 @@ array will be stored in the session. However, it is best to standardize
your data among all your products in order to make displaying the
information in a table easier.
+::
+
+ $data = array(
+ 'id' => 'sku_123ABC',
+ 'qty' => 1,
+ 'price' => 39.95,
+ 'name' => 'T-Shirt',
+ 'coupon' => 'XMAS-50OFF'
+ );
+
+ $this->cart->insert($data);
+
The insert() method will return the $rowid if you successfully insert a
single item.
@@ -194,7 +206,7 @@ Updating The Cart
To update the information in your cart, you must pass an array
containing the Row ID and quantity to the $this->cart->update()
-function:
+function.
.. note:: If the quantity is set to zero, the item will be removed from
the cart.
@@ -227,6 +239,21 @@ function:
$this->cart->update($data);
+You may also update any property you have previously
+defined when inserting the item such as options, price
+or other custom fields you defined.
+
+::
+
+ $data = array(
+ 'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
+ 'qty' => 1,
+ 'price' => 49.95,
+ 'coupon' => NULL
+ );
+
+ $this->cart->update($data);
+
What is a Row ID?
*****************
@@ -289,10 +316,10 @@ Class Reference
:returns: TRUE on success, FALSE on failure
:rtype: bool
- This method permits the quantity of a given item to be changed.
+ This method permits changing the properties of a given item.
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.
+ to the quantity before checkout. That array must contain the rowid
+ and qty for each item.
.. method:: remove($rowid)