[![Latest Version on Packagist](https://img.shields.io/packagist/v/wearepixel/laravel-cart.svg?style=flat-square)](https://packagist.org/packages/wearepixel/laravel-cart)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/wearepixel/laravel-cart/tests.yml?branch=master&label=Tests)](https://github.com/wearepixel/laravel-cart/actions?query=workflow%3ATests+branch%3Amaster)
[![Total Downloads](https://img.shields.io/packagist/dt/wearepixel/laravel-cart.svg?style=flat-square)](https://packagist.org/packages/wearepixel/laravel-cart)
[![License](https://poser.pugx.org/wearepixel/laravel-cart/license.svg)](https://packagist.org/packages/wearepixel/laravel-cart)

A Cart Implementation for Laravel.

Supported Laravel Versions: 9, 10, 11

## Quick Demo

```php
// Add an item to the cart
\Cart::add(1, 'Product 1', 19.99, 2, ['size' => 'large']);

// Get the cart contents
$cartContents = \Cart::getContent();

// Update item quantity by its id
\Cart::update(1, ['quantity' => 3]);

// Remove an item from the cart by its id
\Cart::remove(1);

// Get cart total
\$total = Cart::getTotal();

// Clear the entire cart
\Cart::clear();
```

## Installing

Install the package through [Composer](http://getcomposer.org/).

`composer require "wearepixel/laravel-cart"`

## Configuration

You can publish the configuration file to customize various options.

```php
php artisan vendor:publish --provider="Wearepixel\Cart\CartServiceProvider" --tag="config"
```

## HOW TO USE

-   [Usage](#usage)
-   [Conditions](#conditions)
-   [Items](#items)
-   [Associating Models](#associating-models)
-   [Instances](#instances)
-   [Exceptions](#exceptions)
-   [Events](#events)
-   [Format Response](#format)
-   [Examples](#examples)
-   [Using Different Storage](#storage)
-   [License](#license)

## Usage

The cart has a default sessionKey that holds the cart data and stores it in the session. 

This
also serves as a cart unique identifier which you can use to bind a cart to a specific user if you want to.

Make sure to call `\Cart::session($sessionKey)` before calling any other cart methods.

Usually this is not required.

```php
// Binds the cart to a unique id (user id, session id, etc.)
\Cart::session(User::first()->id);

// If you don't want to bind the cart on a project level, you can add it to each call
\Cart::session(User::first()->id)->add(1, 'Product 1', 19.99, 2, ['size' => 'large']);
```

### Adding to the cart: **Cart::add()**

There are a few ways to add items to the cart.

```php
// Add a simple product to the cart
Cart::add(
    455, # product id
    'Sample Item', # product name
    100.99, # product price
    2, # quantity
    [] # optional attributes
);

// array format
Cart::add([
    456, # product id
    'Leather Shoes', # product name
    187, # product price
    1, # quantity
    [] # optional attributes
]);


// add an item with attributes
Cart::add([
    457, // product id
    'T-Shirt', // product name
    29.99, // product price
    1, // quantity
    [
        'size' => 'L',
        'color' => 'Blue'
    ] // attributes
]);

// add an item with conditions
Cart::add([
    458, // product id
    'Headphones', // product name
    199.99, // product price
    1, // quantity
    [], // attributes
    [
        [
            'name' => '10% Off', 
            'type' => 'discount', 
            'value' => '-10%'
        ]
    ] // conditions
]);

// add multiple items at one time
Cart::add(
    [
        456, # product id
        'Leather Shoes', # product name
        187, # product price
        1, # quantity
        [] # optional attributes
    ],
    [
        431, # product id
        'Leather Jacket', # product name
        254.50, # product price
        1, # quantity
        [] # optional attributes
    ]
);
```

### Updating an item on a cart: **Cart::update()**

```php
Cart::update(
    456, # product id
    [   
        'name' => 'New Item Name', // new item name
        'price' => 98.67, // new item price as a float or string
    ]
);

// updating a product's quantity
Cart::update(
    456, # product id
    [
    'quantity' => 2, // by default adding the quantity (so if from 4 to 6)
    ]
);

// reducing it...
Cart::update(
    456, 
    [
        'quantity' => -1, // so if from 4 to 3
    ]
);

// you can replace the quantity by setting relative to false
Cart::update(
    456, # product id
    [
        'quantity' => [
            'relative' => false,
            'value' => 5 // if the quantity was 2, it will now be 5
        ],
    ]
);
```

### Removing an item on a cart: **Cart::remove()**

```php
// Remove an item from the cart by its id
Cart::remove(456);
```

### Getting an item on a cart: **Cart::get()**

```php
// Get an item from the cart by its id
Cart::get(456);

// You can also get the total price of the item
$summedPrice = Cart::get($itemId)->getPriceSum();
```

### Getting the cart content: **Cart::getContent()**

```php
// Returns a collection of the cart's contents
$cartData = Cart::getContent();

// Gets the total number of items (not quantity) in the cart
$cartCollection->count();

// Transform the collection to an array or a JSON
$cartCollection->toArray();
$cartCollection->toJson();
```

Get cart total quantity: **Cart::getTotalQuantity()**

```php
$cartTotalQuantity = Cart::getTotalQuantity();
```

### Cart subtotal: **Cart::getSubTotal()**

```php
$subTotal = Cart::getSubTotal();
```

### Cart subtotal without conditions: **Cart::getSubTotalWithoutConditions()**

```php
$subTotalWithoutConditions = Cart::getSubTotalWithoutConditions();
```

Cart Total: **Cart::getTotal()**

```php
$total = Cart::getTotal();
```

### Check if cart is empty: **Cart::isEmpty()**

```php
Cart::isEmpty();
```

### Clearing the Cart: **Cart::clear()**

```php
Cart::clear();
```

## Conditions

Conditions are very useful in terms for adding things like discounts, taxes, shipping costs, etc.

Conditions can be added on the entire cart or on individual items.

Conditions on a cart level should always have a `target` of `subtotal` or `total`. This tells the cart which value to apply the condition to.

You can also provide an `order` to cart conditions which tells the cart in what order to apply the conditions. Item level conditions do not support the `order` parameter.

### Conditions on the cart

#### Adding a condition to the cart: **Cart::condition()**

```php
// Add a single condition to the cart
$condition = new \Wearepixel\Cart\CartCondition([
    'name' => 'Tax: 10%',
    'type' => 'tax',
    'target' => 'subtotal', // this condition will be applied to cart's subtotal when getSubTotal() is called.
    'value' => '10%',
    'attributes' => [ // add extra attributes here
    	'description' => 'Compulsory tax',
    ]
]);

Cart::condition($condition);

// Add multiple conditions
$tax = new \Wearepixel\Cart\CartCondition([
    'name' => 'Tax: 10%',
    'type' => 'tax',
    'target' => 'subtotal', // this condition will be applied to cart's subtotal when getSubTotal() is called.
    'value' => '10%',
    'order' => 2
]);

$shipping = new \Wearepixel\Cart\CartCondition([
    'name' => 'Shipping: $15',
    'type' => 'shipping',
    'target' => 'subtotal', // this condition will be applied to cart's subtotal when getSubTotal() is called.
    'value' => '+15',
    'order' => 1
]);

Cart::condition($tax);
Cart::condition($shipping);

// or as an array
Cart::condition([$tax, $shipping]);

// add condition to only apply on totals, not in subtotal
$shipping = new \Wearepixel\Cart\CartCondition([
    'name' => 'Express Shipping $15',
    'type' => 'shipping',
    'target' => 'total',
    'value' => '+15',
    'order' => 1
]);

Cart::condition($shipping);
```

#### Getting conditions on the cart: **Cart::getConditions()**

```php
// To get all applied conditions on a cart, use below:
$cartConditions = Cart::getConditions();

foreach($cartConditions as $condition)
{
    $condition->getTarget(); // the target of which the condition was applied
    $condition->getName(); // the name of the condition
    $condition->getType(); // the type
    $condition->getValue(); // the value of the condition
    $condition->getOrder(); // the order of the condition
    $condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
}

// You can also get a condition that has been applied on the cart by using its name:
$condition = Cart::getCondition('Tax: 10%');
$condition->getTarget(); // the target of which the condition was applied
$condition->getName(); // the name of the condition
$condition->getType(); // the type
$condition->getValue(); // the value of the condition
$condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
```

### Calculating condition value

There are 2 ways to calculate the value of a condition:

1. Using the `getCalculatedValue` method on the condition instance
2. Using the `getCalculatedValueForCondition` method on the cart instance and passing the condition name

#### Using the `getCalculatedValue` method on the condition instance

```php
$subTotal = Cart::getSubTotal();
$condition = Cart::getCondition('VAT 12.5%');
$conditionCalculatedValue = $condition->getCalculatedValue($subTotal);
```

#### Using the `getCalculatedValueForCondition` method on the cart instance

This method automatically calculates the value of a condition by it's name based on the order of the conditions.

```php
Cart::add([
    'id' => 1,
    'name' => 'Apple iPhone 15',
    'price' => 200,
    'quantity' => 1,
    'attributes' => [],
]);

$couponDiscount = new CartCondition([
    'name' => 'Coupon Discount',
    'type' => 'discount',
    'target' => 'subtotal',
    'value' => '-200',
    'order' => 1,
]);

$giftCard = new CartCondition([
    'name' => 'Gift Card',
    'type' => 'discount',
    'target' => 'subtotal',
    'value' => '-200',
    'order' => 2,
]);

Cart::getCalculatedValueForCondition('Coupon Discount'); // returns 200
Cart::getCalculatedValueForCondition('Gift Card'); // returns 0 as the coupon discount is applied first and brings the subtotal to 0
```

### Condition on items

Item conditions are useful if you have discounts to be applied specifically on an item and not on the whole cart value.

```php

// lets create first our condition instance
$saleCondition = new \Wearepixel\Cart\CartCondition([
    'name' => '50% Off',
    'type' => 'tax',
    'value' => '-50%',
]);

// Create the product data with the condition
$product = [
    'id' => 456,
    'name' => 'Sample Item 1',
    'price' => 100,
    'quantity' => 1,
    'attributes' => [],
    'conditions' => $saleCondition
];

// Now add the product to the cart
Cart::add($product);

// You can of course also do multiple conditions on an item
$saleCondition = new \Wearepixel\Cart\CartCondition([
    'name' => 'SALE 5%',
    'type' => 'sale',
    'value' => '-5%',
]);

$discountCode = new CartCondition([
    'name' => 'Discount Code',
    'type' => 'promo',
    'value' => '-25',
]);

$item = [
    'id' => 456,
    'name' => 'Sample Item 1',
    'price' => 100,
    'quantity' => 1,
    'attributes' => [],
    'conditions' => [$saleCondition, $discountCode]
];

Cart::add($item);
```

> NOTE: All cart per-item conditions should be added before calling **Cart::getSubTotal()**

Then Finally you can call **Cart::getSubTotal()** to get the Cart sub total with the applied conditions on each of the items.

```php
// the subtotal will be calculated based on the conditions added that has target => "subtotal"
// and also conditions that are added on per item
$cartSubTotal = Cart::getSubTotal();
```

#### Add condition to existing Item on the cart: **Cart::addItemCondition($productId, $itemCondition)**

Adding Condition to an existing Item on the cart is simple as well.

```php
$condition = new CartCondition([
    'name' => 'COUPON 101',
    'type' => 'coupon',
    'value' => '-5%',
]);

Cart::addItemCondition(456, $condition);
```

### Clearing Cart Conditions: **Cart::clearCartConditions()**

```php
Cart::clearCartConditions()
```

### Remove a specific cart condtion: **Cart::removeCartCondition($conditionName)**

```php
Cart::removeCartCondition('Summer Sale 5%')
```

### Remove a specific item condition: **Cart::removeItemCondition($itemId, $conditionName)**

```php
Cart::removeItemCondition(456, 'SALE 5%')
```

### Clear all item conditions: **Cart::clearItemConditions($itemId)**

```php
Cart::clearItemConditions(456)
```

### Get conditions by type: **Cart::getConditionsByType($type)**

This returns all conditions that has been added to the cart by the type specified.

```php
$tax = Cart::getConditionsByType('tax');
```

### Remove conditions by type: **Cart::removeConditionsByType($type)**

```php
Cart::removeConditionsByType('tax');
```

## Cart Items

The method **Cart::getContent()** returns a collection of items.

Apart from the above methods, you can also get the price of an item with or without **item level conditions** applied.

These methods do not apply cart level conditions.

```php
// With no conditions, just the price * quantity
$item->getPriceSum();

// With conditions applied get the price of a single quantity
$item->getPriceWithConditions();

// Get the sum with conditions applied
$item->getPriceSumWithConditions();

// Without conditions applied
$item->getPriceSumWithConditions();
```

## Credits

Huge credits to the original maintainer of the package, located at [darryldecode/laravelshoppingcart](https://github.com/darryldecode/laravelshoppingcart)

We have forked this package to update it to Laravel 11 and to add some features and support for newer PHP versions.