darthsoup / shoppingcart
Laravel 5 Shoppingcart
Installs: 5 390
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- php: ^7.2.5|^8.0
- illuminate/events: ~6.0|~7.0|~8.0
- illuminate/session: ~6.0|~7.0|~8.0
- illuminate/support: ~6.0|~7.0|~8.0
Requires (Dev)
- mockery/mockery: ~1.3
- orchestra/testbench: 5.x
- phpunit/phpunit: ^8.5.8|^9.3.3
This package is auto-updated.
Last update: 2024-10-18 05:57:22 UTC
README
An easy shoppingcart implementation for Laravel > 6. Based on the work of Gloudemans\Shoppingcart.
Features
This package for shopping carts provides these features:
- Cart items can have subitems
- Custom hash algorithms for item identifiers
- Individual taxing for single items
- Database Support
Installation
To get the latest version, simply require the library using Composer.
$ composer require darthsoup/shoppingcart
Once installed, you'll need to publish the vendor assets
$ php artisan vendor:publish --provider="DarthSoup\Cart\CartServiceProvider" --tag="config"
This will create cart.php
config file.
Usage
The cart package provides you the following methods to use:
Add Item
/** * Add a Item to the cart. * * @param string|array $id Unique ID of the item|Item formatted as array|Array of items * @param string $name Name of the item * @param int $quantity Item quantity to add to the cart * @param float $price Price of one item * @param array $options Array of additional options, such as 'size' or 'color' */ // Basic form Cart::add('1', 'Product One', 1, 9.99, ['option_key' => 'option_value']); // Array form Cart::add(['id' => 'mail1000', 'name' => 'Mail Package One', 'quantity' => 5, 'price' => 4.99, 'options' => []]); // Batch method Cart::add([ ['id' => '15', 'name' => 'Hamburger', 'quantity' => 1, 'price' => 1.99], ['id' => '16', 'name' => 'Cheeseburger', 'quantity' => 1, 'price' => 2.49, 'options' => ['onion' => false]] ]);
you also can make Items by make them manually
$item = new \DarthSoup\Cart\Item('15', 'Hamburger', 1.99, ['onion' => false]); Cart::add($item);
Update one Item
Cart::update('rowId', [ 'options' => ['foo' => 'bar'] ]);
Get One Cart Item
Cart::get('rowId');
Show Cart Content
Show the content of the Cart by returning the CartCollection
Cart::content();
Empty the cart
Cart::destroy();
Remove one Item or Subitem
Cart::remove('rowId');
Total Price of all Items
Cart::total();
Item Count
Cart::count();
SubItems
This package also includes the functionality to add Subitems by adding them to an additional collection in the Item
Add SubItem
The addSubItem
function works basically like add
but it accepts a parent row Id at the end to add an SubItem
to the item.
$hamburger = Cart::add('15', 'Hamburger', 1, 1.99, ['onion' => false]); Cart::addSubItem('99', 'Extra Bacon', 1, 0.99, [], $hamburger->getRowId());
Remove SubItem
Just like removing normal ones, just include your subItem rowId
and it will be removed from the parent
Models
A new feature is associating a model with the items in the cart. Let's say you have a Product
model in your application. With the associate()
method, you can tell the cart that an item in the cart, is associated to the Product
model.
That way you can access your model right from the CartCollection
!
Here is an example:
<?php Cart::associate(\App\Product::class)->add('15', 'Hamburger', 1, 9.99, ['extra_sauce' => true]); $content = Cart::content(); foreach ($content as $row) { echo 'You have ' . $row->quantity . ' items of ' . $row->model->name . ' with description: "' . $row->model->description . '" in your cart.'; }
Using the key model
to access the model that you associated.
Exceptions
The Cart package will throw exceptions if something goes wrong. This way it's easier to debug your code using the Cart package or to handle the error based on the type of exceptions. The Cart packages can throw the following exceptions:
Events
The cart also has events build in. There are five events available for you to listen for.
Contributions
Please use Github for reporting bugs, and making comments or suggestions. See CONTRIBUTING.md for how to contribute changes.