Blame - user_guide/libraries/cart.html - code-igniter-v3-giggi

<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide  <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>

48

</tr>

49

</table>

50

<h1>Shopping Cart Class</h1>

60

61

<p>The Cart Class permits items to be added to a session that stays active while a user is browsing your site.

62

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.</p>

63

64

<p>Please note that the Cart Class ONLY provides the core "cart" functionality. It does not provide shipping, credit card authorization, or other processing components.</p>

65

66

67

<h2>Initializing the Shopping Cart Class</h2>

68

69

<p><strong>Important:</strong> The Cart class utilizes CodeIgniter's

70

<a href="sessions.html">Session Class</a> to save the cart information to a database, so before using the Cart class you must set up a database table

71

as indicated in the <a href="sessions.html">Session Documentation</a> , and set the session preferences in your <kbd>appliction/config/config.php</kbd> file to utilize a database.</p>

72

73

<p>To initialize the Shopping Cart Class in your controller constructor, use the <dfn>$this->load->library</dfn> function:</p>

74

75

<code>$this->load->library('cart');</code>

76

<p>Once loaded, the Cart object will be available using: <dfn>$this->cart</dfn></p>

77

78

<p class="important"><strong>Note:</strong> 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.</p>

79

80

<h2>Adding an Item to The Cart</h2>

81

82

<p>To add an item to the shopping cart, simply pass an array with the product information to the <dfn>$this->cart->insert()</dfn> function, as shown below:</p>

<code>

$data = array(<br />

               'id'      => 'sku_123ABC',<br />

87

               'qty'     => 1,<br />

88

               'price'   => 39.95,<br />

89

               'name'    => 'T-Shirt',<br />

90

               'options' => array('Size' => 'L', 'Color' => 'Red')<br />

            );<br />

<br />

$this->cart->insert($data);

</code>

<p class="important"><strong>Important:</strong> The first four array indexes above (<dfn>id</dfn>, <dfn>qty</dfn>, <dfn>price</dfn>, and <dfn>name</dfn>) are <strong>required</strong>.

99

If you omit any of them the data will not be saved to the cart. The fifth index (<dfn>options</dfn>) is optional.

100

It is intended to be used in cases where your product has options associated with it. Use an array for options, as shown above.</p>

101

102

<p>The five reserved indexes are:</p>

103

104

<ul>

105

<li><strong>id</strong> - Each product in your store must have a unique identifier. Typically this will be an "sku" or other such identifier.</li>

106

<li><strong>qty</strong> - The quantity being purchased.

107

<li><strong>price</strong> - The price of the item.

108

<li><strong>name</strong> - The name of the item.

109

<li><strong>options</strong> - Any additional attributes that are needed to identify the product. These must be passed via an array.

110

</ul>

111

112

<p>In addition to the five indexes above, there are two reserved words: <dfn>rowid</dfn> and <dfn>subtotal</dfn>. These are used internally by the Cart class, so

113

please do NOT use those words as index names when inserting data into the cart.</p>

114

115

<p>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

116

all your products in order to make displaying the information in a table easier.</p>

117

118

119

<h2>Adding Multiple Items to The Cart</h2>

120

121

<p>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

122

people to select from among several items on the same page.</p>

<code>

$data = array(<br />

               array(<br />

129

                       'id'      => 'sku_123ABC',<br />

130

                       'qty'     => 1,<br />

131

                       'price'   => 39.95,<br />

132

                       'name'    => 'T-Shirt',<br />

133

                       'options' => array('Size' => 'L', 'Color' => 'Red')<br />

134

                    ),<br />

135

136

               array(<br />

137

                       'id'      => 'sku_567ZYX',<br />

138

                       'qty'     => 1,<br />

139

                       'price'   => 9.95,<br />

140

                       'name'    => 'Coffee Mug'<br />

141

                    ),<br />

142

143

               array(<br />

144

                       'id'      => 'sku_965QRS',<br />

145

                       'qty'     => 1,<br />

146

                       'price'   => 29.95,<br />

147

                       'name'    => 'Shot Glass'<br />

148

                    )<br />

            );<br />

<br />

$this->cart->insert($data);

</code>

<h2>Displaying the Cart</h2>

161

162

<p>To display the cart you will create a <a href="../general/views.html">view file</a> with code similar to the one shown below.</p>

163

164

<p>Please note that this example uses the <a href="../helpers/form_helper.html">form helper</a>.</p>

<?php echo form_open('path/to/controller/update/function'); ?>

<tr>

<th>Item Description</th>

175

<th style="text-align:right">Item Price</th>

176

<th style="text-align:right">Sub-Total</th>

</tr>

<?php $i = 1; ?>

<?php foreach($this->cart->contents() as $items): ?>

182

183

<?php echo form_hidden($i.'[rowid]', $items['rowid']); ?>

184

185

<tr>

186

<td><?php echo form_input(array('name' => $i.'[qty]', 'value' => $items['qty'], 'maxlength' => '3', 'size' => '5')); ?></td>

187

<td>

188

<?php echo $items['name']; ?>

189

190

<?php if ($this->cart->has_options($items['rowid']) == TRUE): ?>

191

192

<p>

193

<?php foreach ($this->cart->product_options($items['rowid']) as $option_name => $option_value): ?>

<?php endforeach; ?>

</p>

<?php endif; ?>

</td>

<td style="text-align:right"><?php echo $this->cart->format_number($items['price']); ?></td>

204

<td style="text-align:right">$<?php echo $this->cart->format_number($items['subtotal']); ?></td>

</tr>

<?php $i++; ?>

<?php endforeach; ?>

<tr>

<td class="right"><strong>Total</strong></td>

214

<td class="right">$<?php echo $this->cart->format_number($this->cart->total()); ?></td>

</tr>

</table>

</textarea>

<h2>Updating The Cart</h2>

226

227

<p>To update the information in your cart, you must pass an array containing the <kbd>Row ID</kbd> and quantity to the <dfn>$this->cart->update()</dfn> function:</p>

228

229

<p class="important"><strong>Note:</strong> If the quantity is set to zero, the item will be removed from the cart.</p>

<code>

$data = array(<br />

               'rowid' => 'b99ccdf16028f015540f341130b6d8ec',<br />

234

               'qty'   => 3<br />

            );<br />

<br />

$this->cart->update($data);

239

240

// Or a multi-dimensional array<br /><br />

241

$data = array(<br />

242

243

               array(<br />

244

                       'rowid'   => 'b99ccdf16028f015540f341130b6d8ec',<br />

245

                       'qty'     => 3<br />

246

                    ),<br />

247

248

               array(<br />

249

                       'rowid'   => 'xw82g9q3r495893iajdh473990rikw23',<br />

250

                       'qty'     => 4<br />

251

                    ),<br />

252

253

               array(<br />

254

                       'rowid'   => 'fh4kdkkkaoe30njgoe92rkdkkobec333',<br />

255

                       'qty'     => 2<br />

256

                    )<br />

            );<br />

<br />

$this->cart->update($data);

</code>

<p><strong>What is a Row ID?</strong>  The <kbd>row ID</kbd> is a unique identifier that is generated by the cart code when an item is added to the cart. The reason a

269

unique ID is created is so that identical products with different options can be managed by the cart.</p>

270

271

<p>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

272

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

273

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.</p>

274

275

<p>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

276

with the "row ID", other then making sure your "view cart" page contains this information in a hidden form field, and making sure it gets passed to the update

277

function when the update form is submitted. Please examine the construction of the "view cart" page above for more information.</p>

<h1>Function Reference</h1>

285

286

<h2>$this->cart->insert();</h2>

287

288

<p>Permits you to add items to the shopping cart, as outlined above.</p>

289

290

291

<h2>$this->cart->update();</h2>

292

293

<p>Permits you to update items in the shopping cart, as outlined above.</p>

294

295

296

<h2>$this->cart->total();</h2>

297

298

<p>Displays the total amount in the cart.</p>

299

300

301

<h2>$this->cart->total_items();</h2>

302

303

<p>Displays the total number of items in the cart.</p>

304

305

306

<h2>$this->cart->contents();</h2>

307

308

<p>Returns an array containing everything in the cart.</p>

<h2>$this->cart->has_options(rowid);</h2>

313

314

<p>Returns TRUE (boolean) if a particular row in the cart contains options. This function is designed to be used in a loop with <dfn>$this->cart->contents()</dfn>, since you must pass the <kbd>rowid</kbd> to this function, as shown in the <dfn>Displaying the Cart</dfn> example above.</p>

315

316

317

<h2>$this->cart->options(rowid);</h2>

318

319

<p>Returns an array of options for a particular product. This function is designed to be used in a loop with <dfn>$this->cart->contents()</dfn>, since you must pass the <kbd>rowid</kbd> to this function, as shown in the <dfn>Displaying the Cart</dfn> example above.</p>

<h2>$this->cart->destroy();</h2>

324

325

<p>Permits you to destroy the cart. This function will likely be called when you are finished processing the customer's order.</p>