Shopping cart for Laravel Application.
composer require "overtrue/laravel-shopping-cart:1.0.*"
or add the following line to your project's composer.json
:
"require": {
"overtrue/laravel-shopping-cart": "1.0.*"
}
then
composer update
After completion of the above, add the follow line to the section providers
of config/app.php
:
'Overtrue\LaravelShoppingCart\ServiceProvider',
And add the follow line to the section aliases
:
'Cart' => 'Overtrue\LaravelShoppingCart\Facade',
Add a new item.
Item | null Cart::add(
string | int $id,
string $name,
int $quantity,
int | float $price
[, array $attributes = []]
);
example:
$row = Cart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
// Item:
// id => 37
// name => 'Item name'
// qty => 5
// price => 100.00
// color => 'red'
// size => 'M'
// total => 500.00
// __raw_id => '8a48aa7c8e5202841ddaf767bb4d10da'
$rawId = $row->rawId();// get __raw_id
$row->qty; // 5
...
Update the specified item.
Item Cart::update(string $rawId, int $quantity);
Item Cart::update(string $rawId, array $arrtibutes);
example:
Cart::update('8a48aa7c8e5202841ddaf767bb4d10da', ['name' => 'New item name');
// or only update quantity
Cart::update('8a48aa7c8e5202841ddaf767bb4d10da', 5);
Get all the items.
Collection Cart::all();
example:
$items = Cart::all();
Get the specified item.
Item Cart::get(string $rawId);
example:
$item = Cart::get('8a48aa7c8e5202841ddaf767bb4d10da');
Remove the specified item by raw ID.
boolean Cart::remove(string $rawId);
example:
Cart::remove('8a48aa7c8e5202841ddaf767bb4d10da');
Clean Shopping Cart.
boolean Cart::destroy();
boolean Cart::clean(); // alias of destroy();
example:
Cart::destroy();// or Cart::clean();
Returns the total of all items.
int | float Cart::total(); // alias of totalPrice();
int | float Cart::totalPrice();
example:
$total = Cart::total();
// or
$total = Cart::totalPrice();
Return the number of rows.
int Cart::countRows();
example:
Cart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
Cart::add(37, 'Item name', 1, 100.00, ['color' => 'red', 'size' => 'M']);
Cart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
Cart::add(127, 'foobar', 15, 100.00, ['color' => 'green', 'size' => 'S']);
$rows = Cart::countRows(); // 2
Returns the quantity of all items
int Cart::count($totalItems = true);
$totalItems
: When false
,will return the number of rows.
example:
Cart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
Cart::add(37, 'Item name', 1, 100.00, ['color' => 'red', 'size' => 'M']);
Cart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
$count = Cart::count(); // 11 (5+1+5)
Search items by property.
Collection Cart::search(array $conditions);
example:
$items = Cart::search(['color' => 'red']);
$items = Cart::search(['name' => 'Item name']);
$items = Cart::search(['qty' => 10]);
Specifies the associated model of item.
Cart Cart::associate(string $modelName);
example:
Cart::associate('App\Models\Product');
$item = Cart::get('8a48aa7c8e5202841ddaf767bb4d10da');
$item->product->name; // $item->product is instanceof 'App\Models\Product'
Collection
and Overtrue\LaravelShoppingCart\Item
are instanceof Illuminate\Support\Collection
, Usage Refer to:Collections - Laravel doc.
properties of Overtrue\LaravelShoppingCart\Item
:
id
- your goods item ID.name
- Name of item.qty
- Quantity of item.price
- Unit price of item.total
- Total price of item.__raw_id
- Unique ID of row.__model
- Name of item associated Model.- ... custom attributes.
And methods:
rawId()
- Return the raw ID of item.
Event Name | Parameters |
---|---|
cart.adding |
($attributes, $cart); |
cart.added |
($attributes, $cart); |
cart.updating |
($row, $cart); |
cart.updated |
($row, $cart); |
cart.removing |
($row, $cart); |
cart.removed |
($row, $cart); |
cart.destroying |
($cart); |
cart.destroyed |
($cart); |
You can easily handle these events, for example:
Event::on('cart.adding', function($attributes, $cart){
// code
});
MIT