Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/overtrue/laravel-shopping-cart
:shopping_cart: Shopping cart for Laravel Application.
https://github.com/overtrue/laravel-shopping-cart
laravel shopping-cart
Last synced: about 2 months ago
JSON representation
:shopping_cart: Shopping cart for Laravel Application.
- Host: GitHub
- URL: https://github.com/overtrue/laravel-shopping-cart
- Owner: overtrue
- License: mit
- Archived: true
- Created: 2015-05-31T14:09:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T00:26:10.000Z (over 3 years ago)
- Last Synced: 2024-07-21T05:23:38.447Z (about 2 months ago)
- Topics: laravel, shopping-cart
- Language: PHP
- Homepage:
- Size: 115 KB
- Stars: 392
- Watchers: 29
- Forks: 80
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Shopping Cart
Shopping cart for Laravel Application.
[](https://travis-ci.org/overtrue/laravel-shopping-cart)
[](https://packagist.org/packages/overtrue/laravel-shopping-cart)
[](https://packagist.org/packages/overtrue/laravel-shopping-cart)
[](https://scrutinizer-ci.com/g/overtrue/laravel-shopping-cart/?branch=master)
[](https://scrutinizer-ci.com/g/overtrue/laravel-shopping-cart/?branch=master)
[](https://packagist.org/packages/overtrue/laravel-shopping-cart)
[](https://packagist.org/packages/overtrue/wechat)
# Installation
```shell
$ composer require "overtrue/laravel-shopping-cart:~2.0"
```
or add the following line to your project's `composer.json`:
```json
"require": {
"overtrue/laravel-shopping-cart": "~2.0"
}
```
then
```shell
$ composer update
```
After completion of the above, add the follow line to the section `providers` of `config/app.php`:
```php
Overtrue\LaravelShoppingCart\ServiceProvider::class,
```
And add the follow line to the section `aliases`:
```php
'ShoppingCart' => Overtrue\LaravelShoppingCart\Facade::class,
```
# Usage
### Add item to cart
Add a new item.
```php
Item | null ShoppingCart::add(
string | int $id,
string $name,
int $quantity,
int | float $price
[, array $attributes = []]
);
```
**example:**
```php
$row = ShoppingCart::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 item
Update the specified item.
```php
Item ShoppingCart::update(string $rawId, int $quantity);
Item ShoppingCart::update(string $rawId, array $arrtibutes);
```
**example:**
```php
ShoppingCart::update('8a48aa7c8e5202841ddaf767bb4d10da', ['name' => 'New item name']);
// or only update quantity
ShoppingCart::update('8a48aa7c8e5202841ddaf767bb4d10da', 5);
```
### Get all items
Get all the items.
```php
Collection ShoppingCart::all();
```
**example:**
```php
$items = ShoppingCart::all();
```
### Get item
Get the specified item.
```php
Item ShoppingCart::get(string $rawId);
```
**example:**
```php
$item = ShoppingCart::get('8a48aa7c8e5202841ddaf767bb4d10da');
```
### Remove item
Remove the specified item by raw ID.
```php
boolean ShoppingCart::remove(string $rawId);
```
**example:**
```php
ShoppingCart::remove('8a48aa7c8e5202841ddaf767bb4d10da');
```
### Destroy cart
Clean Shopping Cart.
```php
boolean ShoppingCart::destroy();
boolean ShoppingCart::clean(); // alias of destroy();
```
**example:**
```php
ShoppingCart::destroy();// or ShoppingCart::clean();
```
### Total price
Returns the total of all items.
```php
int | float ShoppingCart::total(); // alias of totalPrice();
int | float ShoppingCart::totalPrice();
```
**example:**
```php
$total = ShoppingCart::total();
// or
$total = ShoppingCart::totalPrice();
```
### Count rows
Return the number of rows.
```php
int ShoppingCart::countRows();
```
**example:**
```php
ShoppingCart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
ShoppingCart::add(37, 'Item name', 1, 100.00, ['color' => 'red', 'size' => 'M']);
ShoppingCart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
ShoppingCart::add(127, 'foobar', 15, 100.00, ['color' => 'green', 'size' => 'S']);
$rows = ShoppingCart::countRows(); // 2
```
### Count quantity
Returns the quantity of all items
```php
int ShoppingCart::count($totalItems = true);
```
`$totalItems` : When `false`,will return the number of rows.
**example:**
```php
ShoppingCart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
ShoppingCart::add(37, 'Item name', 1, 100.00, ['color' => 'red', 'size' => 'M']);
ShoppingCart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
$count = ShoppingCart::count(); // 11 (5+1+5)
```
### Search items
Search items by property.
```php
Collection ShoppingCart::search(array $conditions);
```
**example:**
```php
$items = ShoppingCart::search(['color' => 'red']);
$items = ShoppingCart::search(['name' => 'Item name']);
$items = ShoppingCart::search(['qty' => 10]);
```
### Check empty
```php
bool ShoppingCart::isEmpty();
```
### Specifies the associated model
Specifies the associated model of item before you add items to cart.
```php
Cart ShoppingCart::associate(string $modelName);
```
**example:**
```php
ShoppingCart::associate('App\Models\Product');
ShoppingCart::add(37, 'Item name', 5, 100.00, ['color' => 'red', 'size' => 'M']);
$item = ShoppingCart::get('8a48aa7c8e5202841ddaf767bb4d10da');
$item->product->name; // $item->product is instanceof 'App\Models\Product'
```
# The Collection And Item
`Collection` and `Overtrue\LaravelShoppingCart\Item` are instanceof `Illuminate\Support\Collection`, Usage Refer to：[Collections - Laravel doc.](http://laravel.com/docs/5.0/collections)
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.
# Events
| Event Name | Parameters |
| ------- | ------- |
| `shopping_cart.adding` | ($attributes, $cart); |
| `shopping_cart.added` | ($attributes, $cart); |
| `shopping_cart.updating` | ($row, $cart); |
| `shopping_cart.updated` | ($row, $cart); |
| `shopping_cart.removing` | ($row, $cart); |
| `shopping_cart.removed` | ($row, $cart); |
| `shopping_cart.destroying` | ($cart); |
| `shopping_cart.destroyed` | ($cart); |
You can easily handle these events, for example:
```php
Event::listen('shopping_cart.adding', function($attributes, $cart){
// code
});
```
## PHP 扩展包开发
> 想知道如何从零开始构建 PHP 扩展包？
>
> 请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— [《PHP 扩展包实战教程 - 从入门到发布》](https://learnku.com/courses/creating-package)
# License
MIT