Remove previously deprecated Cart Library

4 files changed, 17 insertions, 415 deletions

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 4d0b4cf4d..6a0b827ae 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -22,6 +22,7 @@ Release Date: Not Released
    -  Removed previously deprecated :doc:`Form Helper <helpers/form_helper>` function ``form_prep()`` (use :php:func:`html_escape()` instead).
    -  Removed previously deprecated *Email Helper* (had only two functions, aliases for PHP's native ``filter_var()`` and ``mail()``).
    -  Removed previously deprecated *Smiley Helper*.
+   -  Removed previously deprecated *Cart Library*.
    -  Removed previously deprecated *Javascript Library* (it was always experimental in the first place).
 
 -  Libraries
@@ -773,7 +774,7 @@ Release Date: March 30, 2015
       -  Added support for templating via an array in addition to the encoded string.
       -  Changed method ``get_total_days()`` to be an alias for :doc:`Date Helper <helpers/date_helper>` :php:func:`days_in_month()`.
 
-   -  :doc:`Cart Library <libraries/cart>` changes include:
+   -  *Cart Library* changes include:
 
       -  Deprecated the library as too specific for CodeIgniter.
       -  Added method ``remove()`` to remove a cart item, updating with quantity of 0 seemed like a hack but has remained to retain compatibility.
@@ -1042,7 +1043,7 @@ Bug fixes for 3.0
 -  Fixed a bug where :doc:`Database Forge <database/forge>` method ``create_table()`` with PostgreSQL database could lead to fetching the whole table.
 -  Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :php:func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it.
 -  Fixed a bug (#797) - :doc:`Date Helper <helpers/date_helper>` :php:func:`timespan()` was using incorrect seconds for year and month.
--  Fixed a bug in :doc:`Cart Library <libraries/cart>` method ``contents()`` where if called without a TRUE (or equal) parameter, it would fail due to a typo.
+-  Fixed a bug in *Cart Library* method ``contents()`` where if called without a TRUE (or equal) parameter, it would fail due to a typo.
 -  Fixed a bug (#406) - SQLSRV DB driver not returning resource on ``db_pconnect()``.
 -  Fixed a bug in :doc:`Image Manipulation Library <libraries/image_lib>` method ``gd_loaded()`` where it was possible for the script execution to end or a PHP E_WARNING message to be emitted.
 -  Fixed a bug in the :doc:`Pagination library <libraries/pagination>` where when use_page_numbers=TRUE previous link and page 1 link did not have the same url.
@@ -1179,7 +1180,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2298) - :doc:`Database Results <database/results>` method ``next_row()`` kept returning the last row, allowing for infinite loops.
 -  Fixed a bug (#2236, #2639) - :doc:`Form Helper <helpers/form_helper>` functions :php:func:`set_value()`, :php:func:`set_select()`, :php:func:`set_radio()`, :php:func:`set_checkbox()` didn't parse array notation for keys if the rule was not present in the :doc:`Form Validation Library <libraries/form_validation>`.
 -  Fixed a bug (#2353) - :doc:`Query Builder <database/query_builder>` erroneously prefixed literal strings with **dbprefix**.
--  Fixed a bug (#78) - :doc:`Cart Library <libraries/cart>` didn't allow non-English letters in product names.
+-  Fixed a bug (#78) - *Cart Library* didn't allow non-English letters in product names.
 -  Fixed a bug (#77) - :doc:`Database Class <database/index>` didn't properly handle the transaction "test mode" flag.
 -  Fixed a bug (#2380) - :doc:`URI Routing <general/routing>` method ``fetch_method()`` returned 'index' if the requested method name matches its controller name.
 -  Fixed a bug (#2388) - :doc:`Email Library <libraries/email>` used to ignore attachment errors, resulting in broken emails being sent.
@@ -1414,9 +1415,8 @@ Release Date: November 14, 2011
 
 -  Libraries
 
-   -  Changed ``$this->cart->insert()`` in the :doc:`Cart
-      Library <libraries/cart>` to return the Row ID if a single
-      item was inserted successfully.
+   -  Changed ``$this->cart->insert()`` in the *Cart Library*
+      to return the Row ID if a single item was inserted successfully.
    -  Added support to set an optional parameter in your callback rules
       of validation using the :doc:`Form Validation
       Library <libraries/form_validation>`.
@@ -1524,9 +1524,8 @@ Release Date: August 20, 2011
       string. See upgrade notes if using database sessions.
    -  Added $this->db->set_dbprefix() to the :doc:`Database
       Driver <database/queries>`.
-   -  Changed $this->cart->insert() in the :doc:`Cart
-      Library <libraries/cart>` to return the Row ID if a single
-      item was inserted successfully.
+   -  Changed ``$this->cart->insert()`` in the *Cart Library*
+      to return the Row ID if a single item was inserted successfully.
    -  Added $this->load->get_var() to the :doc:`Loader
       library <libraries/loader>` to retrieve global vars set with
       $this->load->view() and $this->load->vars().
@@ -1551,8 +1550,8 @@ Bug fixes for 2.0.3
    properly escaped.
 -  Fixed issue #199 - Attributes passed as string does not include a
    space between it and the opening tag.
--  Fixed a bug where the method $this->cart->total_items() from :doc:`Cart
-   Library <libraries/cart>` now returns the sum of the quantity
+-  Fixed a bug where the method ``$this->cart->total_items()`` from
+   *Cart Library* now returns the sum of the quantity
    of all items in the cart instead of your total count.
 -  Fixed a bug where not setting 'null' when adding fields in db_forge
    for mysql and mysqli drivers would default to NULL instead of NOT
@@ -1971,7 +1970,7 @@ Hg Tag: v1.7.2
 
 -  Libraries
 
-   -  Added a new :doc:`Cart Class <libraries/cart>`.
+   -  Added a new *Cart Class*.
    -  Added the ability to pass $config['file_name'] for the :doc:`File
       Uploading Class <libraries/file_uploading>` and rename the
       uploaded file.
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 54f635cc0..7b9082679 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -559,12 +559,12 @@ implemented cryptographic functions.
 The Cart library
 ================
 
-The :doc:`Cart Library <../libraries/cart>`, similarly to the *Smiley Helper*
-is too specific for CodeIgniter. It is now deprecated and scheduled for
-removal in CodeIgniter 3.1+.
+The *Cart Library*, similarly to the *Smiley Helper* is too specific for
+CodeIgniter. It is now deprecated and scheduled for removal in
+CodeIgniter 3.1+.
 
-.. note:: The library is still available, but you're strongly encouraged to remove its usage sooner
-	rather than later.
+.. note:: The library is still available, but you're strongly encouraged to
+	remove its usage sooner rather than later.
 
 Database drivers 'mysql', 'sqlite', 'mssql', 'pdo/dblib'
 ========================================================
diff --git a/user_guide_src/source/installation/upgrade_320.rst b/user_guide_src/source/installation/upgrade_320.rst
index 597e1ecf2..b587470f2 100644
--- a/user_guide_src/source/installation/upgrade_320.rst
+++ b/user_guide_src/source/installation/upgrade_320.rst
@@ -147,6 +147,7 @@ version 3.0.x, that have been removed in 3.2.0:
 - ``read_file()`` :doc:`File Helper <../helpers/file_helper>` function (use ``file_get_contents()`` instead)
 - ``form_prep()`` :doc:`Form Helper <../helpers/form_helper>` function (use :php:func:`html_escape()` instead)
 
+- The entire *Cart Library* (an archived version is available on GitHub: `bcit-ci/ci3-cart-library <https://github.com/bcit-ci/ci3-cart-library>`_)
 - The entire *Javascript Library* (it was always experimental in the first place)
 
 - The entire *Email Helper*, which only had two functions:
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
deleted file mode 100644
index be343320d..000000000
--- a/user_guide_src/source/libraries/cart.rst
+++ /dev/null
@@ -1,398 +0,0 @@
-###################
-Shopping Cart Class
-###################
-
-The Cart Class permits items to be added to a session that stays active
-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 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"
-functionality. It does not provide shipping, credit card authorization,
-or other processing components.
-
-.. contents::
-  :local:
-
-.. raw:: html
-
-  <div class="custom-index container"></div>
-
-********************
-Using the Cart Class
-********************
-
-Initializing the Shopping Cart Class
-====================================
-
-.. important:: The Cart class utilizes CodeIgniter's :doc:`Session
-	Class <sessions>` to save the cart information to a database, so
-	before using the Cart class you must set up a database table as
-	indicated in the :doc:`Session Documentation <sessions>`, and set the
-	session preferences in your application/config/config.php file to
-	utilize a database.
-
-To initialize the Shopping Cart Class in your controller constructor,
-use the ``$this->load->library()`` method::
-
-	$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
-	automatically, so unless you are using sessions elsewhere in your
-	application, you do not need to load the Session class.
-
-Adding an Item to The Cart
-==========================
-
-To add an item to the shopping cart, simply pass an array with the
-product information to the ``$this->cart->insert()`` method, as shown
-below::
-
-	$data = array(
-		'id'      => 'sku_123ABC',
-		'qty'     => 1,
-		'price'   => 39.95,
-		'name'    => 'T-Shirt',
-		'options' => array('Size' => 'L', 'Color' => 'Red')
-	);
-
-	$this->cart->insert($data);
-
-.. important:: The first four array indexes above (id, qty, price, and
-	name) are **required**. If you omit any of them the data will not be
-	saved to the cart. The fifth index (options) is optional. It is intended
-	to be used in cases where your product has options associated with it.
-	Use an array for options, as shown above.
-
-The five reserved indexes are:
-
--  **id** - Each product in your store must have a unique identifier.
-   Typically this will be an "sku" or other such identifier.
--  **qty** - The quantity being purchased.
--  **price** - The price of the item.
--  **name** - The name of the item.
--  **options** - Any additional attributes that are needed to identify
-   the product. These must be passed via an array.
-
-In addition to the five indexes above, there are two reserved words:
-rowid and subtotal. These are used internally by the Cart class, so
-please do NOT use those words as index names when inserting data into
-the cart.
-
-Your array may contain additional data. Anything you include in your
-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.
-
-Adding Multiple Items to The Cart
-=================================
-
-By using a multi-dimensional array, as shown below, it is possible to
-add multiple products to the cart in one action. This is useful in cases
-where you wish to allow people to select from among several items on the
-same page.
-
-::
-
-	$data = array(
-		array(
-			'id'      => 'sku_123ABC',
-			'qty'     => 1,
-			'price'   => 39.95,
-			'name'    => 'T-Shirt',
-			'options' => array('Size' => 'L', 'Color' => 'Red')
-		),
-		array(
-			'id'      => 'sku_567ZYX',
-			'qty'     => 1,
-			'price'   => 9.95,
-			'name'    => 'Coffee Mug'
-		),
-		array(
-			'id'      => 'sku_965QRS',
-			'qty'     => 1,
-			'price'   => 29.95,
-			'name'    => 'Shot Glass'
-		)
-	);
-
-	$this->cart->insert($data);
-
-Displaying the Cart
-===================
-
-To display the cart you will create a :doc:`view
-file </general/views>` with code similar to the one shown below.
-
-Please note that this example uses the :doc:`form
-helper </helpers/form_helper>`.
-
-::
-
-	<?php echo form_open('path/to/controller/update/method'); ?>
-
-	<table cellpadding="6" cellspacing="1" style="width:100%" border="0">
-
-	<tr>
-		<th>QTY</th>
-		<th>Item Description</th>
-		<th style="text-align:right">Item Price</th>
-		<th style="text-align:right">Sub-Total</th>
-	</tr>
-
-	<?php $i = 1; ?>
-
-	<?php foreach ($this->cart->contents() as $items): ?>
-
-		<?php echo form_hidden($i.'[rowid]', $items['rowid']); ?>
-
-		<tr>
-			<td><?php echo form_input(array('name' => $i.'[qty]', 'value' => $items['qty'], 'maxlength' => '3', 'size' => '5')); ?></td>
-			<td>
-				<?php echo $items['name']; ?>
-
-				<?php if ($this->cart->has_options($items['rowid']) == TRUE): ?>
-
-					<p>
-						<?php foreach ($this->cart->product_options($items['rowid']) as $option_name => $option_value): ?>
-
-							<strong><?php echo $option_name; ?>:</strong> <?php echo $option_value; ?><br />
-
-						<?php endforeach; ?>
-					</p>
-
-				<?php endif; ?>
-
-			</td>
-			<td style="text-align:right"><?php echo $this->cart->format_number($items['price']); ?></td>
-			<td style="text-align:right">$<?php echo $this->cart->format_number($items['subtotal']); ?></td>
-		</tr>
-
-	<?php $i++; ?>
-
-	<?php endforeach; ?>
-
-	<tr>
-		<td colspan="2"> </td>
-		<td class="right"><strong>Total</strong></td>
-		<td class="right">$<?php echo $this->cart->format_number($this->cart->total()); ?></td>
-	</tr>
-
-	</table>
-
-	<p><?php echo form_submit('', 'Update your Cart'); ?></p>
-
-Updating The Cart
-=================
-
-To update the information in your cart, you must pass an array
-containing the Row ID and one or more pre-defined properties to the 
-``$this->cart->update()`` method.
-
-.. note:: If the quantity is set to zero, the item will be removed from
-	the cart.
-
-::
-
-	$data = array(
-		'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
-		'qty'   => 3
-	);
-
-	$this->cart->update($data);
-
-	// Or a multi-dimensional array
-
-	$data = array(
-		array(
-			'rowid'   => 'b99ccdf16028f015540f341130b6d8ec',
-			'qty'     => 3
-		),
-		array(
-			'rowid'   => 'xw82g9q3r495893iajdh473990rikw23',
-			'qty'     => 4
-		),
-		array(
-			'rowid'   => 'fh4kdkkkaoe30njgoe92rkdkkobec333',
-			'qty'     => 2
-		)
-	);
-
-	$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.
-
-::
-
-	$data = array(
-		'rowid'  => 'b99ccdf16028f015540f341130b6d8ec',
-		'qty'    => 1,
-		'price'	 => 49.95,
-		'coupon' => NULL
-	);
-
-	$this->cart->update($data);
-
-What is a Row ID?
-*****************
-
-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, let's say 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 it's 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.
-
-In nearly all cases, updating the cart will be something the user does
-via the "view cart" page, so as a developer, it is unlikely that you
-will ever have to concern yourself with the "row ID", other than making
-sure your "view cart" page contains this information in a hidden form
-field, and making sure it gets passed to the ``update()`` method when
-the update form is submitted. Please examine the construction of the
-"view cart" page above for more information.
-
-
-***************
-Class Reference
-***************
-
-.. php: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.
-
-
-	.. php:method:: insert([$items = array()])
-
-		:param	array	$items: Items to insert into the cart
-		:returns:	TRUE on success, FALSE on failure
-		:rtype:	bool
-
-		Insert items into the cart and save it to the session table. Returns TRUE
-		on success and FALSE on failure.
-
-
-	.. php:method:: update([$items = array()])
-
-		:param	array	$items: Items to update in the cart
-		:returns:	TRUE on success, FALSE on failure
-		:rtype:	bool
-
-		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 rowid
-		for each item.
-
-	.. php:method:: remove($rowid)
-
-		:param	int	$rowid: ID of the item to remove from the cart
-		:returns:	TRUE on success, FALSE on failure
-		:rtype:	bool
-
-		Allows you to remove an item from the shopping cart by passing it the
-		``$rowid``.
-
-	.. php:method:: total()
-
-		:returns:	Total amount
-		:rtype:	int
-
-		Displays the total amount in the cart.
-
-
-	.. php:method:: total_items()
-
-		:returns:	Total amount of items in the cart
-		:rtype:	int
-
-		Displays the total number of items in the cart.
-
-
-	.. 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
-		:rtype:	array
-
-		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.
-
-	.. php:method:: get_item($row_id)
-
-		:param	int	$row_id: Row ID to retrieve
-		:returns:	Array of item data
-		:rtype:	array
-
-		Returns an array containing data for the item matching the specified row
-		ID, or FALSE if no such item exists.
-
-	.. php:method:: has_options($row_id = '')
-
-		:param	int	$row_id: Row ID to inspect
-		:returns:	TRUE if options exist, FALSE otherwise
-		:rtype:	bool
-
-		Returns TRUE (boolean) if a particular row in the cart contains options.
-		This method is designed to be used in a loop with ``contents()``, since
-		you must pass the rowid to this method, as shown in the Displaying
-		the Cart example above.
-
-	.. php:method:: product_options([$row_id = ''])
-
-		:param	int	$row_id: Row ID
-		:returns:	Array of product options
-		:rtype:	array
-
-		Returns an array of options for a particular product. This method is
-		designed to be used in a loop with ``contents()``, since you
-		must pass the rowid to this method, as shown in the Displaying the
-		Cart example above.
-
-	.. php:method:: destroy()
-
-		:rtype: void
-
-		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