Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomshaw/shopcart
A modern easy to use Laravel shopping cart
https://github.com/tomshaw/shopcart
Last synced: 11 days ago
JSON representation
A modern easy to use Laravel shopping cart
- Host: GitHub
- URL: https://github.com/tomshaw/shopcart
- Owner: tomshaw
- License: mit
- Created: 2023-07-07T16:29:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-29T20:52:55.000Z (8 months ago)
- Last Synced: 2024-04-14T04:44:29.358Z (7 months ago)
- Language: PHP
- Size: 49.8 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ShopCart 🛒
[](https://github.com/tomshaw/shopcart/blob/master/LICENSE)
ShopCart is a modern easy to use [Laravel](https://laravel.com) shopping cart.
## Installation
You can install the package via composer:
```bash
composer require tomshaw/shopcart
```
Publish configuration file
```
php artisan vendor:publish --provider="TomShaw\ShopCart\Providers\ShopCartServiceProvider" --tag=config
```
## Requirements
The package is compatible with Laravel 10 and 11.
## Basic Usage
Adding an item to the shopping cart.
> Note: Cart item constructor properties are validated when creating or updating cart items.
> Note: A unique random integer `rowId` is created and used to identify cart items.
```php
use TomShaw\ShopCart\{Cart, CartItem};
$cartItem = CartItem::make(id: $product->id, name: $product->name, quantity: 1, price: $product->price);
Cart::add($cartItem);
```
Adding an item with product options to the shopping cart.
```php
$cartItem = CartItem::make($product->id, $product->name, 1, $product->price);
$cartItem->size = 'XL';
$cartItem->logo = 'Laravel Rocks';
Cart::add($cartItem);
```
Updating an item and product options in the shoping cart.
```php
$cartItem = Cart::where('id', '===', $id)->first();
$cartItem->quantity = 5;
$cartItem->size = '2XL';
Cart::update($cartItem);
```
Removing an item from the shopping cart.
```php
Cart::remove(Cart::get($rowId));
```
Deleting the shopping cart after checkout.
```php
Cart::forget();
```
## Cart Totals
> Sums the properties: `tax`, `price`, `subtotal` and `quantity`.
```php
$totalPrice = Cart::total('price');
```
```php
$totalQuantity = Cart::total(property: 'quantity', numberFormat: false);
```
```php
$subTotal = Cart::total('subtotal');
```
```php
$totalTax = Cart::total('tax');
```
## Tax Rates
To set a default tax rate add the following environment variable in your application `.env`.
```sh
SHOPCART_DEFAULT_TAXRATE=9.547
```
You can easily apply item specific tax rates at run time.
```php
use TomShaw\ShopCart\{Cart, CartItem};
Cart::add(CartItem::make(tax: 6.250, ...));
```
## Number Formatting
Number formating is handled by adding the following environment variables to your application `.env`.
```sh
SHOPCART_DECIMALS=2
SHOPCART_DECIMAL_SEPARATOR="."
SHOPCART_THOUSANDS_SEPARATOR=","
```
### Proxy Methods
Get item from collection by `rowId`.
```php
$cartItem = Cart::get($rowId);
```
Check if cart item exists by `rowId`.
```php
$boolean = Cart::has($rowId);
```
Get cart as collection or array.
```php
$cartItems = Cart::all(bool $toArray = false);
```
Searching for specific cart items.
```php
$cartItems = Cart::where('id', '===', $productId);
```
Check if the cart is empty or not.
```php
Cart::isEmpty();
```
```php
Cart::isNotEmpty();
```
Casting the cart as an `array` or `json`;
```php
Cart::toArray();
```
```php
Cart::toJson();
```
## Changelog
For changes made to the project, see the [Changelog](CHANGELOG.md).
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). See [License File](LICENSE) for more information.