CodeIgniter 4 officially not supporting Cart Library like CI3. but we will use the same cart in CI4. Let’s get Started.
STEP 1
Create a file ‘Cart.php’ in ‘app/Libraries/’. e.g. (app/Libraries/Cart.php) and Copy Bellow Code to your Codeigniter 4 App/Libraries/Cart.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 | <?php namespace App\Libraries { use Config\Services; /** * The Cart class is a basic port of the CodeIgniter 3 cart module for * CodeIgniter 4. * * @package App\Libraries * * @copyright Copyright (c) 2014 - 2017, British Columbia Institute of Technology (http://bcit.ca/) * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/) * @link https://codeigniter.com/user_guide/libraries/cart.html * @license http://opensource.org/licenses/MIT * @author EllisLab Dev Team * @since 1.0.0 * @deprecated 3.0.0 */ class Cart { /** * These are the regular expression rules that we use to validate the product ID and product name * alpha-numeric, dashes, underscores, or periods * * @var string */ public $productIdRules = '\.a-z0-9_-'; /** * These are the regular expression rules that we use to validate the product ID and product name * alpha-numeric, dashes, underscores, colons or periods * * @var string */ public $productNameRules = '\w \-\.\:'; /** * only allow safe product names * * @var bool */ public $productNameSafe = true; /** * Contents of the cart * * @var array */ protected $cartContents = []; /** * Session Service * * @var \CodeIgniter\Session\Session $session */ protected $session; // ------------------------------------------------------------------------ /** * Shopping Class Constructor * * The constructor loads the Session class, used to store the shopping cart contents. */ public function __construct() { $this->session = Services::session(); // Grab the shopping cart array from the session table $this->cartContents = $this->session->get('cart_contents'); if ( $this->cartContents === null ) { // No cart exists so we'll set some base values $this->cartContents = [ 'cart_total' => 0, 'total_items' => 0 ]; } log_message('info', 'Cart Class Initialized'); } // -------------------------------------------------------------------- /** * Insert items into the cart and save it to the session table * * @param array $items * * @return bool */ public function insert($items = []): bool { // Was any cart data passed? No? Bah... if ( ! is_array($items) || count($items) === 0 ) { log_message('error', 'The insert method must be passed an array containing data.'); return false; } // You can either insert a single product using a one-dimensional array, // or multiple products using a multi-dimensional one. The way we // determine the array type is by looking for a required array key named "id" // at the top level. If it's not found, we will assume it's a multi-dimensional array. $save_cart = false; if ( isset($items[ 'id' ]) ) { if ( ( $rowid = $this->_insert($items) ) ) { $save_cart = true; } } else { foreach ( $items as $val ) { if ( is_array($val) && isset($val[ 'id' ]) && $this->_insert($val) ) { $save_cart = true; } } } // Save the cart data if the insert was successful if ( $save_cart === true ) { $this->saveCart(); return $rowid ?? true; } return false; } // ------------------------------------------------------------------------ /** * Insert * * @param array $items * @return bool|string */ protected function _insert($items = []) { // Was any cart data passed? No? Bah... if ( ! is_array($items) || count($items) === 0 ) { log_message('error', 'The insert method must be passed an array containing data.'); return false; } // -------------------------------------------------------------------- // Does the $items array contain an id, quantity, price, and name? These are required if ( ! isset($items[ 'id' ], $items[ 'qty' ], $items[ 'price' ], $items[ 'name' ]) ) { log_message('error', 'The cart array must contain a product ID, quantity, price, and name.'); return false; } // -------------------------------------------------------------------- // Prep the quantity. It can only be a number. Duh... also trim any leading zeros $items[ 'qty' ] = (float)$items[ 'qty' ]; // If the quantity is zero or blank there's nothing for us to do if ( $items[ 'qty' ] === 0 ) { return false; } // -------------------------------------------------------------------- // Validate the product ID. It can only be alpha-numeric, dashes, underscores or periods // Not totally sure we should impose this rule, but it seems prudent to standardize IDs. // Note: These can be user-specified by setting the $this->product_id_rules variable. if ( ! preg_match('/^[' . $this->productIdRules . ']+$/i', $items[ 'id' ]) ) { log_message('error', 'Invalid product ID. The product ID can only contain alpha-numeric characters, dashes, and underscores'); return false; } // -------------------------------------------------------------------- // Validate the product name. It can only be alpha-numeric, dashes, underscores, colons or periods. // Note: These can be user-specified by setting the $this->product_name_rules variable. if ( $this->productNameSafe && ! preg_match('/^[' . $this->productNameRules . ']+$/i' . ( true ? 'u' : '' ), $items[ 'name' ]) ) { log_message('error', 'An invalid name was submitted as the product name: ' . $items[ 'name' ] . ' The name can only contain alpha-numeric characters, dashes, underscores, colons, and spaces'); return false; } // -------------------------------------------------------------------- // Prep the price. Remove leading zeros and anything that isn't a number or decimal point. $items[ 'price' ] = (float)$items[ 'price' ]; // We now need to create a unique identifier for the item being inserted into the cart. // Every time something is added to the cart it is stored in the master cart array. // Each row in the cart array, however, must have a unique index that identifies not only // a particular product, but makes it possible to store identical products with different options. // For example, what if someone buys two identical t-shirts (same product ID), but in // different sizes? The product ID (and other attributes, like the name) will be identical for // both sizes because it's the same shirt. The only difference will be the size. // Internally, we need to treat identical submissions, but with different options, as a unique product. // Our solution is to convert the options array to a string and MD5 it along with the product ID. // This becomes the unique "row ID" if ( isset($items[ 'options' ]) && count($items[ 'options' ]) > 0 ) { $rowid = md5($items[ 'id' ] . serialize($items[ 'options' ])); } else { // No options were submitted so we simply MD5 the product ID. // Technically, we don't need to MD5 the ID in this case, but it makes // sense to standardize the format of array indexes for both conditions $rowid = md5($items[ 'id' ]); } // -------------------------------------------------------------------- // Now that we have our unique "row ID", we'll add our cart items to the master array // grab quantity if it's already there and add it on $old_quantity = isset($this->cartContents[ $rowid ][ 'qty' ]) ? (int)$this->cartContents[ $rowid ][ 'qty' ] : 0; // Re-create the entry, just to make sure our index contains only the data from this submission $items[ 'rowid' ] = $rowid; $items[ 'qty' ] += $old_quantity; $this->cartContents[ $rowid ] = $items; return $rowid; } // ------------------------------------------------------------------------ /** * Update the cart * * This function 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. * * @param array $items * @return bool */ public function update($items = []): bool { // Was any cart data passed? if ( ! is_array($items) || count($items) === 0 ) { return false; } // You can either update a single product using a one-dimensional array, // or multiple products using a multi-dimensional one. The way we // determine the array type is by looking for a required array key named "rowid". // If it's not found we assume it's a multi-dimensional array $save_cart = false; if ( isset($items[ 'rowid' ]) ) { if ( $this->_update($items) === true ) { $save_cart = true; } } else { foreach ( $items as $val ) { if ( is_array($val) && isset($val[ 'rowid' ]) && $this->_update($val) === true ) { $save_cart = true; } } } // Save the cart data if the insert was successful if ( $save_cart === true ) { $this->saveCart(); return true; } return false; } // ------------------------------------------------------------------------ /** * Update the cart * * This function permits changing item properties. * 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 and quantity for each item. * * @param array $items * @return bool */ protected function _update($items = []): bool { // Without these array indexes there is nothing we can do if ( ! isset($items[ 'rowid' ], $this->cartContents[ $items[ 'rowid' ] ]) ) { return false; } // Prep the quantity if ( isset($items[ 'qty' ]) ) { $items[ 'qty' ] = (float)$items[ 'qty' ]; // Is the quantity zero? If so we will remove the item from the cart. // If the quantity is greater than zero we are updating if ( $items[ 'qty' ] === 0 ) { unset($this->cartContents[ $items[ 'rowid' ] ]); return true; } } // find updatable keys $keys = array_intersect(array_keys($this->cartContents[ $items[ 'rowid' ] ]), array_keys($items)); // if a price was passed, make sure it contains valid data if ( isset($items[ 'price' ]) ) { $items[ 'price' ] = (float)$items[ 'price' ]; } // product id & name shouldn't be changed foreach ( array_diff($keys, [ 'id', 'name' ]) as $key ) { $this->cartContents[ $items[ 'rowid' ] ][ $key ] = $items[ $key ]; } return true; } // ------------------------------------------------------------------------ /** * Save the cart array to the session DB * * @return bool */ protected function saveCart(): bool { // Let's add up the individual prices and set the cart sub-total $this->cartContents[ 'total_items' ] = $this->cartContents[ 'cart_total' ] = 0; foreach ( $this->cartContents as $key => $val ) { // We make sure the array contains the proper indexes if ( ! is_array($val) || ! isset($val[ 'price' ], $val[ 'qty' ]) ) { continue; } $this->cartContents[ 'cart_total' ] += ( $val[ 'price' ] * $val[ 'qty' ] ); $this->cartContents[ 'total_items' ] += $val[ 'qty' ]; $this->cartContents[ $key ][ 'subtotal' ] = ( $this->cartContents[ $key ][ 'price' ] * $this->cartContents[ $key ][ 'qty' ] ); } // Is our cart empty? If so we delete it from the session if ( count($this->cartContents) <= 2 ) { $this->session->remove('cart_contents'); // Nothing more to do... coffee time! return false; } // If we made it this far it means that our cart has data. // Let's pass it to the Session class so it can be stored $this->session->set('cart_contents', $this->cartContents); // Woot! return true; } // ------------------------------------------------------------------------ /** * Cart Total * * @return mixed */ public function total() { return $this->cartContents[ 'cart_total' ]; } // ------------------------------------------------------------------------ /** * Remove Item * * Removes an item from the cart * * @param $rowid * * @return bool */ public function remove($rowid): bool { // unset & save unset($this->cartContents[ $rowid ]); $this->saveCart(); return true; } // ------------------------------------------------------------------------ /** * Total Items * * Returns the total item count * * @return mixed */ public function totalItems() { return $this->cartContents[ 'total_items' ]; } // ------------------------------------------------------------------------ /** * Cart Contents * * Returns the entire cart array * * @param bool $newest_first * @return array */ public function contents($newest_first = false): array { // do we want the newest first? $cart = ( $newest_first ) ? array_reverse($this->cartContents) : $this->cartContents; // Remove these so they don't create a problem when showing the cart table unset($cart[ 'total_items' ], $cart[ 'cart_total' ]); return $cart; } // ------------------------------------------------------------------------ /** * Get cart item * * Returns the details of a specific item in the cart * * @param $row_id * @return bool|mixed */ public function getItem($row_id) { return ( in_array($row_id, [ 'total_items', 'cart_total' ], true) OR ! isset($this->cartContents[ $row_id ]) ) ? false : $this->cartContents[ $row_id ]; } // ------------------------------------------------------------------------ /** * Has options * * Returns TRUE if the rowid passed to this function correlates to an item * that has options associated with it. * * @param string $row_id * @return bool */ public function hasOptions($row_id = ''): bool { return ( isset($this->cartContents[ $row_id ][ 'options' ]) && count($this->cartContents[ $row_id ][ 'options' ]) !== 0 ); } // ------------------------------------------------------------------------ /** * Product options * * Returns the an array of options, for a particular product row ID * * @param string $row_id * @return array|mixed */ public function productOptions($row_id = '') { return $this->cartContents[ $row_id ][ 'options' ] ?? []; } // ------------------------------------------------------------------------ /** * Format Number * * Returns the supplied number with commas and a decimal point. * * @param string $n * @return string */ public function formatNumber($n = ''): string { return ( $n === '' ) ? '' : number_format((float)$n, 2); } // ------------------------------------------------------------------------ /** * Destroy the cart * * Empties the cart and kills the session */ public function destroy(): void { $this->cartContents = [ 'cart_total' => 0, 'total_items' => 0 ]; $this->session->remove('cart_contents'); } // ------------------------------------------------------------------------ } } ?> |
STEP 2
Copy Bellow Code to your Codeigniter 4 app/Config/Services.php
1 2 3 4 5 6 7 | public static function cart($getShared = true) { if ($getShared) { return static::getSharedInstance('cart'); } return new \App\Libraries\Cart(); } |
STEP 3
Copy Bellow Code to your Codeigniter 4 app/Common.php
1 2 3 4 | function cart(bool $getShared = true) { return \Config\Services::cart($getShared); } |
That’s DONE, Now you can use cart() like ci3. example given below
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | // Call the cart service using the helper function $cart = cart(); // Insert an array of values $cart->insert(array( 'id' => 'sku_1234ABCD', 'qty' => 1, 'price' => '19.56', 'name' => 'T-Shirt', 'options' => array('Size' => 'L', 'Color' => 'Red') )); // Update an array of values $cart->update(array( 'rowid' => '345e7fc8446e81e16883e9a812db8', 'id' => 'sku_1234ABCD', 'qty' => 3, 'price' => '24.89', 'name' => 'T-Shirt', 'options' => array('Size' => 'L', 'Color' => 'Red') )); // Get the total items $cart->totalItems(); // Remove an item using its `rowid` $cart->remove('4166b0e7fc8446e81e16883e9a812db8'); // Clear the shopping cart $cart->destroy(); // Get the cart contents as an array $cart->contents(); |
Credit : Manoj Bist