melihovv / Laravel Shopping Cart
Labels
Projects that are alternatives of or similar to Laravel Shopping Cart
Laravel Shopping Cart
Install
Install via composer
composer require melihovv/laravel-shopping-cart
Publish configuration file and migrations
php artisan vendor:publish --provider="Melihovv\ShoppingCart\ServiceProvider"
Run migrations
php artisan migrate
Overview
Usage
Regiser facade in config/app.php
'Cart' => 'Melihovv\ShoppingCart\Facades\ShoppingCart',
or
use Melihovv\ShoppingCart\Facades\ShoppingCart as Cart;
in the below examples.
The shopping cart gives you the following methods to use:
Cart::add()
Add an item to the shopping cart.
$cartItem = Cart::add($id, $name, $price, $quantity);
$cartItem = Cart::add($id, $name, $price, $quantity, [
'color' => 'white',
]);
Cart::remove()
Remove the item with the specified unique id from the shopping cart. Unique id
is used to store items with the same $id
, but different $options
.
$cartItem = Cart::add($id, $name, $price, $quantity);
// ...
Cart::remove($cartItem->getUniqueId())
Cart::has()
Check if the shopping cart contains the item with the specified unique id.
$cartItem = Cart::add($id, $name, $price, $quantity);
// ...
if (Cart::has($cartItem->getUniqueId())) {
// Do smth.
}
Cart::get()
Get an item in the shopping cart by its unique id.
$cartItem = Cart::add($id, $name, $price, $quantity);
// ...
$cartItem = Cart::get($cartItem->getUniqueId());
Cart::content()
Get all items in the shopping cart.
Cart::clear()
Clear the shopping cart.
Cart::count()
Return number of items in the shopping cart. This method does not summarize quantities of item. For example, there are 3 books and 1 iPhone in the shopping cart, so this method returns 2.
Cart::getTotal()
Return total price of all items in the shopping cart.
Cart::add(1, 'iPhone 7', 500, 1);
Cart::add(1, 'iPad Pro', 700, 2);
Cart::getTotal(); // return 1900
Instances
The package supports multiple instances of the cart. Some examples:
Cart::instance('shopping')->add('192ao12', 'Product 1', 100, 10);
// Store and get the content of the 'shopping' cart
Cart::store->content();
Cart::instance('wishlist')->add('sdjk922', 'Product 2', 50, 1, ['size' => 'medium']);
// Store and get the content of the 'wishlist' cart
Cart::store()->content();
// If you want to get the content of the 'shopping' cart again
Cart::instance('shopping')->restore()->content();
The default cart instance is called default
, so when you're not using
instances,Cart::content();
is the same as Cart::instance('default')->content()
.
Cart::instance()
Set current instance name.
Cart::currentInstance()
Get current instance name.
Storage
Currently there are two possible storage to persist shopping cart:
- Database
- Redis
You can choose one by specifying repository class name in config
// config/shopping-cart.php
'repository' => \Melihovv\ShoppingCart\Repositories\ShoppingCartDatabaseRepository::class,
// or
'repository' => \Melihovv\ShoppingCart\Repositories\ShoppingCartRedisRepository::class,
In order to use redis storage you also need to install predis/predis
package.
Cart::store()
Persist current shopping cart instance to storage.
Cart::store($user->id);
Cart::instance('cart')->store($user->id);
Cart::instance('wishlist')->store($user->id);
Cart::restore()
Restore shopping cart instance to storage.
Cart::restore($user->id);
Cart::instance('cart')->restore($user->id);
Cart::instance('wishlist')->restore($user->id);
Cart::destroy()
Remove shopping cart instance from storage.
Cart::destroy($user->id);
Cart::instance('cart')->destroy($user->id);
Cart::instance('wishlist')->destroy($user->id);
Coupons
You can easily add discount coupons to shopping cart. Currently there are two types of coupons:
- FixedDiscountCoupon
- PercentDiscountCoupon
Related methods:
Cart::addCoupon()
Add coupon to cart.
Cart::addCoupon(new FixedDiscountCoupon($name, $discount));
Cart::addCoupon(new PercentDiscountCoupon($name, 0.1)); // 10% discount
Cart::coupons()
Returns all coupons.
Cart::getTotalWithCoupons()
Returns total price with applied coupons.
Cart::add(1, 'iPhone 7', 500, 1);
Cart::add(1, 'iPad Pro', 700, 2);
Cart::addCoupon(new FixedDiscountCoupon($name, 300));
Cart::getTotal(); // return 1900 - 300 = 1600
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.