mirror of
https://github.com/wearepixel/laravel-cart.git
synced 2026-11-14 22:01:48 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e61ffae5fe | ||
|
|
10ab30f4e8 | ||
|
|
34626eef5e | ||
|
|
6020b655e2 | ||
|
|
2c56062f97 | ||
|
|
b2a4864675 | ||
|
|
aaa3360d1f | ||
|
|
05729b7865 | ||
|
|
7e6ee749bf | ||
|
|
17532f1b05 | ||
|
|
d058ad5521 | ||
|
|
3f5e9374c3 | ||
|
|
fcdd356718 | ||
|
|
3500fa43a9 | ||
|
|
28a72581fc | ||
|
|
ddcf38dab0 | ||
|
|
e7bf1ba3a3 | ||
|
|
ebf5a41e01 | ||
|
|
e0d566cebd | ||
|
|
863ef52e8d | ||
|
|
6638f812c8 | ||
|
|
8f442f51e0 | ||
|
|
6dfd0ce761 | ||
|
|
a3161888aa | ||
|
|
4c02310bf7 | ||
|
|
e810eb4ef4 | ||
|
|
4cf078277d | ||
|
|
7adf5ecd1f | ||
|
|
158cf38f14 | ||
|
|
0f07b9ae8a | ||
|
|
ec99aa0563 | ||
|
|
8d6e1bcc26 | ||
|
|
b92dce9ca4 | ||
|
|
2196f58f01 | ||
|
|
ed4d112665 | ||
|
|
f60bf92157 | ||
|
|
a231ed8c43 | ||
|
|
599051631c | ||
|
|
b3ef4c38fc | ||
|
|
a45121ca63 | ||
|
|
5505f121c7 | ||
|
|
472d505041 | ||
|
|
c6c4240c5f | ||
|
|
54d7c8a54f | ||
|
|
a8d743eb9b | ||
|
|
b7381573e8 | ||
|
|
d4d4df7d58 | ||
|
|
6ea2cb3b8b | ||
|
|
7a2c41e02d | ||
|
|
9a59857825 | ||
|
|
43238b6f2e | ||
|
|
c0f0fcd2f0 | ||
|
|
185c4572ae | ||
|
|
c111cda3aa | ||
|
|
ab9eb6c873 | ||
|
|
7ee26add8d | ||
|
|
05318b7b13 | ||
|
|
4d2efcdeae | ||
|
|
a269c188e4 | ||
|
|
2ccba20119 | ||
|
|
313a4f7aa2 | ||
|
|
4a312a37e2 | ||
|
|
274a8504af | ||
|
|
4f22672ca5 | ||
|
|
61475a7060 | ||
|
|
6604cf984d | ||
|
|
7d955d722c | ||
|
|
54d94d8d12 | ||
|
|
e49ebe02e0 | ||
|
|
28b451583d | ||
|
|
3673f360b7 | ||
|
|
f6447ad4d9 | ||
|
|
b102dd2356 | ||
|
|
25fc662c05 | ||
|
|
57328c2f64 | ||
|
|
4d19211f2c | ||
|
|
8cee4f6208 | ||
|
|
0ec0668bcf |
+19
-3
@@ -1,17 +1,33 @@
|
||||
version: 2
|
||||
|
||||
updates:
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
target-branch: "develop"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "monday"
|
||||
open-pull-requests-limit: 10
|
||||
groups:
|
||||
actions:
|
||||
patterns: ["*"]
|
||||
commit-message:
|
||||
prefix: "chore"
|
||||
include: "scope"
|
||||
labels:
|
||||
- "dependencies"
|
||||
|
||||
- package-ecosystem: "composer"
|
||||
directory: "/"
|
||||
target-branch: "develop"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "tuesday"
|
||||
open-pull-requests-limit: 10
|
||||
groups:
|
||||
php-minor-patch:
|
||||
update-types:
|
||||
- "minor"
|
||||
- "patch"
|
||||
commit-message:
|
||||
prefix: "chore"
|
||||
include: "scope"
|
||||
labels:
|
||||
- "dependencies"
|
||||
|
||||
@@ -13,7 +13,7 @@ jobs:
|
||||
|
||||
- name: Dependabot metadata
|
||||
id: metadata
|
||||
uses: dependabot/fetch-metadata@v2.2.0
|
||||
uses: dependabot/fetch-metadata@25dd0e34f4fe68f24cc83900b1fe3fe149efef98 # v3.1.0
|
||||
with:
|
||||
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
name: PHP Formatting
|
||||
|
||||
on: pull_request
|
||||
|
||||
jobs:
|
||||
php-formatting:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: "Run Pint"
|
||||
uses: aglipanci/laravel-pint-action@latest
|
||||
with:
|
||||
verboseMode: true
|
||||
configPath: "pint.json"
|
||||
pintVersion: 1.17.2
|
||||
|
||||
- name: Commit changes
|
||||
uses: stefanzweifel/git-auto-commit-action@v5
|
||||
with:
|
||||
commit_message: "Apply Laravel Pint"
|
||||
commit_options: '--no-verify --signoff'
|
||||
file_pattern: "*.php"
|
||||
commit_user_name: "Pixel Tech"
|
||||
commit_user_email: "tech@wearepixel.com.au"
|
||||
commit_author: "Pixel Tech<tech@wearepixel.com.au>"
|
||||
@@ -9,19 +9,19 @@ on:
|
||||
jobs:
|
||||
tests:
|
||||
name: Tests
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: true
|
||||
matrix:
|
||||
php: ['8.1','8.2', '8.3']
|
||||
php: ["8.3", "8.4", "8.5"]
|
||||
stability: [prefer-stable]
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
uses: shivammathur/setup-php@7c071dfe9dc99bdf297fa79cb49ea005b9fcadbc # v2
|
||||
with:
|
||||
php-version: ${{ matrix.php }}
|
||||
extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd, redis, memcached
|
||||
@@ -29,12 +29,11 @@ jobs:
|
||||
coverage: none
|
||||
|
||||
- name: Install dependencies
|
||||
uses: nick-fields/retry@v3
|
||||
uses: nick-fields/retry@ad984534de44a9489a53aefd81eb77f87c70dc60 # v4.0.0
|
||||
with:
|
||||
timeout_minutes: 5
|
||||
max_attempts: 5
|
||||
command: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress ${{ matrix.flags }}
|
||||
|
||||
|
||||
- name: Execute tests
|
||||
run: vendor/bin/pest
|
||||
@@ -3,3 +3,5 @@
|
||||
.idea
|
||||
.phpunit.result.cache
|
||||
READMETODO.md
|
||||
build
|
||||
docs/superpowers/
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Pixel <hello@wearepixel.com.au>
|
||||
Copyright (c) Joel Male <joel@joelmale.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
@@ -1,41 +1,74 @@
|
||||
<a name="top"></a>
|
||||
[](https://joelmale.com)
|
||||
[](https://packagist.org/packages/wearepixel/laravel-cart)
|
||||
[](https://github.com/wearepixel/laravel-cart/actions?query=workflow%3ATests+branch%3Amaster)
|
||||
[](https://packagist.org/packages/wearepixel/laravel-cart)
|
||||
[](#)
|
||||
[](https://packagist.org/packages/wearepixel/laravel-cart)
|
||||
[](#-license)
|
||||
|
||||
A Cart Implementation for Laravel.
|
||||
|
||||
Supported Laravel Versions: 9, 10, 11
|
||||
Supported Laravel Versions: 10, 11, 12, and 13.
|
||||
|
||||
## Quick Demo
|
||||
For Laravel 9.0 and below, please use version [1.0](https://github.com/wearepixel/laravel-cart/releases/tag/1.0.12)
|
||||
|
||||
```php
|
||||
// Add an item to the cart
|
||||
\Cart::add(1, 'Product 1', 19.99, 2, ['size' => 'large']);
|
||||
## Table of Contents
|
||||
|
||||
// Get the cart contents
|
||||
$cartContents = \Cart::getContent();
|
||||
- [Getting Started](#-getting-started)
|
||||
- [Demo](#-deni)
|
||||
- [Documentation](#-documentation)
|
||||
- [Configuration](#configuration)
|
||||
- [Basic Usage](#basic-usage)
|
||||
- [Conditions](#conditions)
|
||||
- [Cart Items](#cart-items)
|
||||
- [Database Support](#database-support)
|
||||
- [Events](#events)
|
||||
- [Credits](#-credits)
|
||||
- [License](#-license)
|
||||
|
||||
// Update item quantity by its id
|
||||
\Cart::update(1, ['quantity' => 3]);
|
||||
## 🚀 Getting Started
|
||||
|
||||
// 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
|
||||
### 🔥 Installing
|
||||
|
||||
Install the package through [Composer](http://getcomposer.org/).
|
||||
|
||||
`composer require "wearepixel/laravel-cart"`
|
||||
`composer require wearepixel/laravel-cart`
|
||||
|
||||
## Configuration
|
||||
## 🧑🍳 Demo
|
||||
|
||||
```php
|
||||
// Add an item to the cart
|
||||
\Cart::add(
|
||||
1, // any unique id
|
||||
'Product 1', // product name
|
||||
19.99, // product price
|
||||
2, // quantity
|
||||
['size' => 'large'] // an array of extra attributes
|
||||
);
|
||||
|
||||
// get the entire cart
|
||||
$cartContents = \Cart::getContent();
|
||||
|
||||
// update an item already in the cart
|
||||
\Cart::update(
|
||||
1, // the same unique id that was used to add the item
|
||||
['quantity' => 3] // the quantity to update
|
||||
);
|
||||
|
||||
// remove the item by its id
|
||||
\Cart::remove(1);
|
||||
|
||||
// get the total of the cart
|
||||
$total = Cart::getTotal();
|
||||
|
||||
// clear it all when you've finished (like when you've stored the order)
|
||||
\Cart::clear();
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### ⚙️ Configuration
|
||||
|
||||
You can publish the configuration file to customize various options.
|
||||
|
||||
@@ -43,7 +76,7 @@ ## Configuration
|
||||
php artisan vendor:publish --provider="Wearepixel\Cart\CartServiceProvider" --tag="config"
|
||||
```
|
||||
|
||||
### Formatting Numbers
|
||||
#### Formatting Numbers
|
||||
|
||||
The package by default does not use round to format numbers, and instead returns the number using floatval().
|
||||
|
||||
@@ -56,7 +89,7 @@ ### Formatting Numbers
|
||||
'round_mode' => env('LARAVEL_CART_ROUND_MODE', 'down'),
|
||||
```
|
||||
|
||||
### Decimals
|
||||
#### Decimals
|
||||
|
||||
You can customize the number of decimals in the configuration file.
|
||||
|
||||
@@ -66,7 +99,7 @@ ### Decimals
|
||||
'decimals' => env('LARAVEL_CART_DECIMALS', 2),
|
||||
```
|
||||
|
||||
### Round Mode
|
||||
#### Round Mode
|
||||
|
||||
The package uses the `round` function to round the prices. You can customize the rounding mode in the configuration file.
|
||||
|
||||
@@ -76,40 +109,22 @@ ### Round Mode
|
||||
'round_mode' => env('LARAVEL_CART_ROUND_MODE', 'down'),
|
||||
```
|
||||
|
||||
## HOW TO USE
|
||||
### Basic Usage
|
||||
|
||||
- [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)
|
||||
The cart has a default sessionKey that holds the cart data and stores it in the session, so you can have multiple carts for multiple users.
|
||||
|
||||
## Usage
|
||||
This also serves as a cart unique identifier which you can use to bind a cart to a specific user if you want to.
|
||||
|
||||
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.
|
||||
Make sure to call `\Cart::setSessionKey($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']);
|
||||
\Cart::setSessionKey(User::first()->id);
|
||||
```
|
||||
|
||||
### Adding to the cart: **Cart::add()**
|
||||
#### Adding to the cart: **Cart::add()**
|
||||
|
||||
There are a few ways to add items to the cart.
|
||||
|
||||
@@ -180,7 +195,7 @@ ### Adding to the cart: **Cart::add()**
|
||||
);
|
||||
```
|
||||
|
||||
### Updating an item on a cart: **Cart::update()**
|
||||
#### Updating an item on a cart: **Cart::update()**
|
||||
|
||||
```php
|
||||
Cart::update(
|
||||
@@ -219,14 +234,14 @@ ### Updating an item on a cart: **Cart::update()**
|
||||
);
|
||||
```
|
||||
|
||||
### Removing an item on a cart: **Cart::remove()**
|
||||
#### 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()**
|
||||
#### Getting an item on a cart: **Cart::get()**
|
||||
|
||||
```php
|
||||
// Get an item from the cart by its id
|
||||
@@ -236,7 +251,7 @@ ### Getting an item on a cart: **Cart::get()**
|
||||
$summedPrice = Cart::get($itemId)->getPriceSum();
|
||||
```
|
||||
|
||||
### Getting the cart content: **Cart::getContent()**
|
||||
#### Getting the cart content: **Cart::getContent()**
|
||||
|
||||
```php
|
||||
// Returns a collection of the cart's contents
|
||||
@@ -256,13 +271,13 @@ ### Getting the cart content: **Cart::getContent()**
|
||||
$cartTotalQuantity = Cart::getTotalQuantity();
|
||||
```
|
||||
|
||||
### Cart subtotal: **Cart::getSubTotal()**
|
||||
#### Cart subtotal: **Cart::getSubTotal()**
|
||||
|
||||
```php
|
||||
$subTotal = Cart::getSubTotal();
|
||||
```
|
||||
|
||||
### Cart subtotal without conditions: **Cart::getSubTotalWithoutConditions()**
|
||||
#### Cart subtotal without conditions: **Cart::getSubTotalWithoutConditions()**
|
||||
|
||||
```php
|
||||
$subTotalWithoutConditions = Cart::getSubTotalWithoutConditions();
|
||||
@@ -274,31 +289,43 @@ ### Cart subtotal without conditions: **Cart::getSubTotalWithoutConditions()**
|
||||
$total = Cart::getTotal();
|
||||
```
|
||||
|
||||
### Check if cart is empty: **Cart::isEmpty()**
|
||||
#### Check if cart is empty: **Cart::isEmpty()**
|
||||
|
||||
```php
|
||||
Cart::isEmpty();
|
||||
```
|
||||
|
||||
### Clearing the Cart: **Cart::clear()**
|
||||
#### Clearing the Cart: **Cart::clear()**
|
||||
|
||||
This clears all items and conditions from the cart.
|
||||
|
||||
```php
|
||||
Cart::clear();
|
||||
```
|
||||
|
||||
## Conditions
|
||||
#### Clearing the cart items only: **Cart::clearItems()**
|
||||
|
||||
Conditions are very useful in terms for adding things like discounts, taxes, shipping costs, etc.
|
||||
This clears all items, but keeps the conditions (useful for when you want to keep the conditions but remove the items)
|
||||
|
||||
Conditions can be added on the entire cart or on individual items.
|
||||
```php
|
||||
Cart::clearItems();
|
||||
```
|
||||
|
||||
### Conditions
|
||||
|
||||
Conditions are very useful for adding things like discounts, taxes, shipping, etc.
|
||||
|
||||
Conditions can be added on the entire cart or on individual items, and can even be applied only at certain cart values.
|
||||
|
||||
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 provide an optional `minimum` value which should be the dollar value in which the target (subtotal or total) needs to be for the condition to be active and impact the cart.
|
||||
|
||||
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
|
||||
#### Conditions on the cart
|
||||
|
||||
#### Adding a condition to the cart: **Cart::condition()**
|
||||
##### Adding a condition to the cart: **Cart::condition()**
|
||||
|
||||
```php
|
||||
// Add a single condition to the cart
|
||||
@@ -349,7 +376,7 @@ #### Adding a condition to the cart: **Cart::condition()**
|
||||
Cart::condition($shipping);
|
||||
```
|
||||
|
||||
#### Getting conditions on the cart: **Cart::getConditions()**
|
||||
##### Getting conditions on the cart: **Cart::getConditions()**
|
||||
|
||||
```php
|
||||
// To get all applied conditions on a cart, use below:
|
||||
@@ -362,34 +389,97 @@ #### Getting conditions on the cart: **Cart::getConditions()**
|
||||
$condition->getType(); // the type
|
||||
$condition->getValue(); // the value of the condition
|
||||
$condition->getOrder(); // the order of the condition
|
||||
$condition->getMinimum(); // the minimum dollar amount of the target, needed to activate the condition
|
||||
$condition->getMaximum(); // the maximum dollar amount of the target, needed to keep the condition active
|
||||
$condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
|
||||
}
|
||||
```
|
||||
|
||||
##### Getting conditions on the cart as an array: **Cart::getConditions(array: true)**
|
||||
|
||||
You can get all cart conditions in array format by passing "array: true". This is useful if you want to store the carts conditions on a Livewire component since by default we have collections inside collections for conditions which Livewire does not support.
|
||||
|
||||
```php
|
||||
$cartConditions = Cart::getConditions(true);
|
||||
$cartConditions = Cart::getConditions(active: true);
|
||||
|
||||
foreach ($cartConditions as $condition) {
|
||||
$condition['name']; // the name of the condition
|
||||
$condition['type']; // the type
|
||||
$condition['value']; // the value of the condition
|
||||
$condition['order']; // the order of the condition
|
||||
$condition['minimum']; // the minimum dollar amount of the target, needed to activate the condition
|
||||
$condition['maximum']; // the maximum dollar amount of the target, needed to keep the condition active
|
||||
$condition['attributes']; // the attributes of the condition, returns an empty [] if no attributes added
|
||||
}
|
||||
```
|
||||
|
||||
##### Getting conditions by name: **Cart::getCondition($conditionName)**
|
||||
|
||||
```php
|
||||
$condition = Cart::getCondition('GST');
|
||||
|
||||
// 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->getMinimum(); // the minimum dollar amount of the target, needed to activate the condition
|
||||
$condition->getMaximum(); // the maximum dollar amount of the target, needed to keep the condition active
|
||||
$condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
|
||||
```
|
||||
|
||||
### Calculating condition value
|
||||
##### Getting active conditions on the cart: **Cart::getConditions(active: true)**
|
||||
|
||||
You can get only active conditions by passsing `active: true` to the `getConditions()` method.
|
||||
|
||||
This will return conditions that are actively being applied to the cart (i.e if they meet their minimum or maximum value)
|
||||
|
||||
```php
|
||||
$tenPercentOff = new CartCondition([
|
||||
'name' => '10% Off',
|
||||
'type' => 'discount',
|
||||
'target' => 'subtotal',
|
||||
'value' => '-10%',
|
||||
'minimum' => 120,
|
||||
'order' => 1,
|
||||
]);
|
||||
|
||||
Cart::getConditions(active: true);
|
||||
|
||||
// will return "10% Off" if the subtotal of the cart is $200.
|
||||
// will return no conditions if the subtotal is $100.
|
||||
|
||||
$shipping = new CartCondition([
|
||||
'name' => 'Shipping',
|
||||
'type' => 'discount',
|
||||
'target' => 'subtotal',
|
||||
'value' => '10',
|
||||
'maximum' => 200,
|
||||
'order' => 1,
|
||||
]);
|
||||
|
||||
Cart::getConditions(active: true);
|
||||
|
||||
// will return "Shipping" if the subtotal of the cart is less than or equal 200
|
||||
// will return no conditions if the subtotal is $210
|
||||
```
|
||||
|
||||
##### 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
|
||||
##### Using the `getCalculatedValue` method on the condition instance
|
||||
|
||||
```php
|
||||
$subTotal = Cart::getSubTotal();
|
||||
$condition = Cart::getCondition('VAT 12.5%');
|
||||
$condition = Cart::getCondition('10% GST');
|
||||
$conditionCalculatedValue = $condition->getCalculatedValue($subTotal);
|
||||
```
|
||||
|
||||
#### Using the `getCalculatedValueForCondition` method on the cart instance
|
||||
##### 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.
|
||||
|
||||
@@ -422,7 +512,45 @@ #### Using the `getCalculatedValueForCondition` method on the cart instance
|
||||
Cart::getCalculatedValueForCondition('Gift Card'); // returns 0 as the coupon discount is applied first and brings the subtotal to 0
|
||||
```
|
||||
|
||||
### Condition on items
|
||||
##### Adding conditions that activate once a minimum value is met
|
||||
|
||||
You can add a `minimum` amount required for a condition to activate.
|
||||
|
||||
This is useful for applying discounts only after certain cart values, i.e: 10% off for any purchases over $120.
|
||||
|
||||
```php
|
||||
$tenPercentOff = new CartCondition([
|
||||
'name' => '10% Off',
|
||||
'type' => 'discount',
|
||||
'target' => 'subtotal',
|
||||
'value' => '-10%',
|
||||
'minimum' => 120,
|
||||
'order' => 1,
|
||||
]);
|
||||
|
||||
Cart::condition($tenPercentOff)
|
||||
```
|
||||
|
||||
##### Adding conditions that only activate up to a maximum value
|
||||
|
||||
You can add a `maximum` amount required for a condition to activate.
|
||||
|
||||
This is useful for applying discounts up until amounts, i.e shipping for anything below $200, and free shipping above.
|
||||
|
||||
```php
|
||||
$shipping = new CartCondition([
|
||||
'name' => 'Shipping',
|
||||
'type' => 'discount',
|
||||
'target' => 'subtotal',
|
||||
'value' => '12',
|
||||
'maximum' => 200,
|
||||
'order' => 1,
|
||||
]);
|
||||
|
||||
Cart::condition($shipping)
|
||||
```
|
||||
|
||||
#### Conditions on items
|
||||
|
||||
Item conditions are useful if you have discounts to be applied specifically on an item and not on the whole cart value.
|
||||
|
||||
@@ -483,7 +611,7 @@ ### Condition on items
|
||||
$cartSubTotal = Cart::getSubTotal();
|
||||
```
|
||||
|
||||
#### Add condition to existing Item on the cart: **Cart::addItemCondition($productId, $itemCondition)**
|
||||
##### Add a condition to an existing item on the cart: **Cart::addItemCondition($productId, $itemCondition)**
|
||||
|
||||
Adding Condition to an existing Item on the cart is simple as well.
|
||||
|
||||
@@ -497,31 +625,39 @@ #### Add condition to existing Item on the cart: **Cart::addItemCondition($produ
|
||||
Cart::addItemCondition(456, $condition);
|
||||
```
|
||||
|
||||
### Clearing Cart Conditions: **Cart::clearCartConditions()**
|
||||
#### Clearing Cart Conditions: **Cart::clearCartConditions()**
|
||||
|
||||
This clears all cart level conditions, and does not affect item level conditions.
|
||||
|
||||
```php
|
||||
Cart::clearCartConditions()
|
||||
```
|
||||
|
||||
### Remove a specific cart condtion: **Cart::removeCartCondition($conditionName)**
|
||||
If you wish to clear all conditions from all items and the cart, use **Cart::clearAllConditions()**
|
||||
|
||||
```php
|
||||
Cart::clearAllConditions()
|
||||
```
|
||||
|
||||
##### Remove a specific cart condtion: **Cart::removeCartCondition($conditionName)**
|
||||
|
||||
```php
|
||||
Cart::removeCartCondition('Summer Sale 5%')
|
||||
```
|
||||
|
||||
### Remove a specific item condition: **Cart::removeItemCondition($itemId, $conditionName)**
|
||||
##### Remove a specific item condition: **Cart::removeItemCondition($itemId, $conditionName)**
|
||||
|
||||
```php
|
||||
Cart::removeItemCondition(456, 'SALE 5%')
|
||||
```
|
||||
|
||||
### Clear all item conditions: **Cart::clearItemConditions($itemId)**
|
||||
##### Clear all item conditions: **Cart::clearItemConditions($itemId)**
|
||||
|
||||
```php
|
||||
Cart::clearItemConditions(456)
|
||||
```
|
||||
|
||||
### Get conditions by type: **Cart::getConditionsByType($type)**
|
||||
#### Get conditions by type: **Cart::getConditionsByType($type)**
|
||||
|
||||
This returns all conditions that has been added to the cart by the type specified.
|
||||
|
||||
@@ -529,13 +665,13 @@ ### Get conditions by type: **Cart::getConditionsByType($type)**
|
||||
$tax = Cart::getConditionsByType('tax');
|
||||
```
|
||||
|
||||
### Remove conditions by type: **Cart::removeConditionsByType($type)**
|
||||
##### Remove conditions by type: **Cart::removeConditionsByType($type)**
|
||||
|
||||
```php
|
||||
Cart::removeConditionsByType('tax');
|
||||
```
|
||||
|
||||
## Cart Items
|
||||
### Cart Items
|
||||
|
||||
The method **Cart::getContent()** returns a collection of items.
|
||||
|
||||
@@ -557,8 +693,153 @@ ## Cart Items
|
||||
$item->getPriceSumWithConditions();
|
||||
```
|
||||
|
||||
## Credits
|
||||
### Storage Options
|
||||
|
||||
Huge credits to the original maintainer of the package, located at [darryldecode/laravelshoppingcart](https://github.com/darryldecode/laravelshoppingcart)
|
||||
By default the cart is stored in the session, but there are times you may want to store the cart in the database.
|
||||
|
||||
We have forked this package to update it to Laravel 11 and to add some features and support for newer PHP versions.
|
||||
For instance, you may want to store the cart in the database so that the cart can be retrieved even after the user logs out or closes the browser, or you may want to add cart timeouts and support for multiple computers.
|
||||
|
||||
#### Session
|
||||
|
||||
The cart is stored in the session by default, using Laravel's in-built SessionManager.
|
||||
|
||||
#### Database Support
|
||||
|
||||
To get started, you'll need to create a new model for your Cart, the package requires only 3 columns, but you're free to extend this as you wish and add more columns.
|
||||
|
||||
You can utilise the [events](#events) provided by the package to store additional information alongside the cart.
|
||||
|
||||
```php
|
||||
$table->string('session_id'); // this handles the session id of the cart
|
||||
$table->text('items'); // this will store the cart items
|
||||
$table->text('conditions'); // this will store the cart level conditions
|
||||
```
|
||||
|
||||
Then add some json casts to your model and fillable columns:
|
||||
|
||||
```php
|
||||
protected $guarded = [];
|
||||
|
||||
protected $casts = [
|
||||
'items' => 'array',
|
||||
'conditions' => 'array',
|
||||
];
|
||||
```
|
||||
|
||||
Then update the configuration file to use the database driver:
|
||||
|
||||
```php
|
||||
'driver' => 'database',
|
||||
|
||||
'storage' => [
|
||||
'session',
|
||||
'database' => [
|
||||
'model' => \App\Models\Cart::class, // your model here
|
||||
'id' => 'session_id',
|
||||
'items' => 'items',
|
||||
'conditions' => 'conditions',
|
||||
],
|
||||
],
|
||||
```
|
||||
|
||||
### Events
|
||||
|
||||
The package provides a few events that you can listen to in order to manipulate the cart or take actions based on cart events.
|
||||
|
||||
#### LaravelCart.Created
|
||||
|
||||
This fires every time a cart is instantiated (i.e every time \Cart::add() is called)
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Added', function () {
|
||||
// cart was created
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Adding
|
||||
|
||||
This fires every time an item is being added to the cart
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Adding', function ($item) {
|
||||
// item is being added
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Added
|
||||
|
||||
This fires every time an item is successfully added to the cart
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Added', function ($item) {
|
||||
// item was added
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Updating
|
||||
|
||||
This fires every time an item is being updated
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Updating', function ($item) {
|
||||
// item is being updated
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Updated
|
||||
|
||||
This fires every time an item is successfully updated
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Updated', function ($item) {
|
||||
// item was updated
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Removing
|
||||
|
||||
This fires every time an item is being removed
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Removing', function ($item) {
|
||||
// item is being removed
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Removed
|
||||
|
||||
This fires every time an item is successfully removed
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Removed', function ($item) {
|
||||
// item was removed
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Clearing
|
||||
|
||||
This fires every time the cart is being cleared
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Clearing', function () {
|
||||
// cart is being cleared
|
||||
});
|
||||
```
|
||||
|
||||
#### LaravelCart.Cleared
|
||||
|
||||
This fires every time the cart is successfully cleared
|
||||
|
||||
```
|
||||
Event::listen('LaravelCart.Cleared', function () {
|
||||
// cart was cleared
|
||||
});
|
||||
```
|
||||
|
||||
## 🫡 Credits
|
||||
|
||||
This package was orignally created by [darryldecode](https://github.com/darryldecode) but has since seen almost no updates. I have decided to take the old package and transform it into a new package with new features and updates.
|
||||
|
||||
## 📓 License
|
||||
|
||||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
# Security Policy
|
||||
|
||||
**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you discover a security vulnerability, please report it privately using the below channel:
|
||||
|
||||
**GitHub Private Vulnerability Reporting** — go to the repository's **Security** tab and click **"Report a vulnerability"**. This creates a private advisory visible only to maintainers and provides a structured workflow for triage, fix coordination, and CVE assignment.
|
||||
|
||||
All security vulnerabilities will be promptly addressed.
|
||||
+16
-9
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "wearepixel/laravel-cart",
|
||||
"version": "1.0.2",
|
||||
"version": "2.1.3",
|
||||
"description": "A cart implementation for Laravel",
|
||||
"keywords": [
|
||||
"laravel",
|
||||
@@ -15,19 +15,21 @@
|
||||
},
|
||||
{
|
||||
"name": "Joel Male",
|
||||
"email": "joel@wearepixel.com.au"
|
||||
"email": "joel@joelmale.com"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=8.0",
|
||||
"illuminate/support": "^9.0|^10.0|^11.0",
|
||||
"illuminate/validation": "^9.0|^10.0|^11.0",
|
||||
"illuminate/translation": "^9.0|^10.0|^11.0"
|
||||
"php": ">=8.3",
|
||||
"illuminate/support": "^11.0|^12.0|^13.0",
|
||||
"illuminate/auth": "^11.0|^12.0|^13.0",
|
||||
"illuminate/container": "^11.0|^12.0|^13.0",
|
||||
"illuminate/database": "^11.0|^12.0|^13.0",
|
||||
"illuminate/validation": "^11.0|^12.0|^13.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"mockery/mockery": "^1.4.2",
|
||||
"laravel/pint": "dev-main",
|
||||
"pestphp/pest": "2.34.4",
|
||||
"mockery/mockery": "^2.0",
|
||||
"laravel/pint": "^1.21",
|
||||
"pestphp/pest": "^4.7",
|
||||
"larapack/dd": "dev-master"
|
||||
},
|
||||
"autoload": {
|
||||
@@ -35,6 +37,11 @@
|
||||
"Wearepixel\\Cart\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Tests\\": "tests/"
|
||||
}
|
||||
},
|
||||
"minimum-stability": "dev",
|
||||
"extra": {
|
||||
"laravel": {
|
||||
|
||||
Generated
+4055
-1625
File diff suppressed because it is too large
Load Diff
+11
-8
@@ -14,15 +14,18 @@
|
||||
|
||||
/*
|
||||
* ---------------------------------------------------------------
|
||||
* Persistence
|
||||
* Storage
|
||||
* ---------------------------------------------------------------
|
||||
*/
|
||||
'storage' => null,
|
||||
'driver' => 'session',
|
||||
|
||||
/*
|
||||
* ---------------------------------------------------------------
|
||||
* Events
|
||||
* ---------------------------------------------------------------
|
||||
*/
|
||||
'events' => null,
|
||||
'storage' => [
|
||||
'session',
|
||||
'database' => [
|
||||
'model' => '',
|
||||
'id' => '',
|
||||
'items' => '',
|
||||
'conditions' => '',
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
-17
@@ -1,17 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
>
|
||||
<testsuites>
|
||||
<testsuite name="Unit">
|
||||
<directory suffix="Test.php">./tests/Unit</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">./src</directory>
|
||||
</include>
|
||||
</source>
|
||||
</phpunit>
|
||||
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd">
|
||||
<source ignoreIndirectDeprecations="true">
|
||||
<include>
|
||||
<directory suffix=".php">./src</directory>
|
||||
</include>
|
||||
</source>
|
||||
<testsuites>
|
||||
<testsuite name="Laravel Cart Test Suite">
|
||||
<directory>tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<php>
|
||||
<env name="DB_CONNECTION" value="testing"/>
|
||||
</php>
|
||||
</phpunit>
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"preset": "laravel",
|
||||
"rules": {
|
||||
"concat_space": {
|
||||
"spacing": "one"
|
||||
},
|
||||
"class_attributes_separation": false,
|
||||
"ordered_imports": {
|
||||
"sort_algorithm": "length"
|
||||
}
|
||||
"preset": "laravel",
|
||||
"rules": {
|
||||
"concat_space": {
|
||||
"spacing": "one"
|
||||
},
|
||||
"class_attributes_separation": false,
|
||||
"ordered_imports": {
|
||||
"sort_algorithm": "length"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+201
-172
@@ -10,91 +10,60 @@
|
||||
|
||||
class Cart
|
||||
{
|
||||
/**
|
||||
* the item storage
|
||||
*/
|
||||
protected $session;
|
||||
|
||||
/**
|
||||
* the event dispatcher
|
||||
*/
|
||||
protected $events;
|
||||
|
||||
/**
|
||||
* the cart session key
|
||||
*/
|
||||
protected $instanceName;
|
||||
|
||||
/**
|
||||
* the session key use for the cart
|
||||
*/
|
||||
protected $sessionKey;
|
||||
|
||||
/**
|
||||
* the session key use to persist cart items
|
||||
*/
|
||||
protected $sessionKeyCartItems;
|
||||
|
||||
/**
|
||||
* the session key use to persist cart conditions
|
||||
*/
|
||||
protected $sessionKeyCartConditions;
|
||||
|
||||
/**
|
||||
* Configuration to pass to ItemCollection
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* This holds the currently added item id in cart for association
|
||||
*/
|
||||
protected $currentItemId;
|
||||
|
||||
/**
|
||||
* The number of decimals to use when formatting prices
|
||||
*/
|
||||
protected $decimals;
|
||||
|
||||
/**
|
||||
* The decimal point character
|
||||
*/
|
||||
protected $decPoint;
|
||||
|
||||
/**
|
||||
* our object constructor
|
||||
*/
|
||||
public function __construct($session, $events, $instanceName, $session_key, $config)
|
||||
public function __construct($sessionStorage, $events, $instanceName, $sessionKey, $config)
|
||||
{
|
||||
$this->validateConfig($config);
|
||||
|
||||
$this->events = $events;
|
||||
$this->session = $session;
|
||||
$this->session = new CartSession($sessionStorage, $sessionKey, $config);
|
||||
$this->instanceName = $instanceName;
|
||||
$this->sessionKey = $session_key;
|
||||
$this->sessionKeyCartItems = $this->sessionKey . '_cart_items';
|
||||
$this->sessionKeyCartConditions = $this->sessionKey . '_cart_conditions';
|
||||
$this->config = $config;
|
||||
$this->currentItemId = null;
|
||||
$this->fireEvent('created');
|
||||
|
||||
$this->fireEvent('Created');
|
||||
}
|
||||
|
||||
/**
|
||||
* sets the session key
|
||||
*
|
||||
* @param string $sessionKey the session key or identifier
|
||||
* @return $this|bool
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function session($sessionKey)
|
||||
private function validateConfig($config)
|
||||
{
|
||||
if (! $sessionKey) {
|
||||
throw new \Exception('Session key is required.');
|
||||
if ($config['driver'] == 'database') {
|
||||
if (! isset($config['storage']['database']['model'])) {
|
||||
throw new \Exception('You need to set a model for the database driver in the cart configuration.');
|
||||
}
|
||||
|
||||
if (! isset($config['storage']['database']['id'])) {
|
||||
throw new \Exception('You need to set an id (for the session) for the database driver in the cart configuration.');
|
||||
}
|
||||
|
||||
if (! isset($config['storage']['database']['items'])) {
|
||||
throw new \Exception('You need to set an items key for the database driver in the cart configuration.');
|
||||
}
|
||||
|
||||
if (! isset($config['storage']['database']['conditions'])) {
|
||||
throw new \Exception('You need to set a conditions key for the database driver in the cart configuration.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->sessionKey = $sessionKey;
|
||||
$this->sessionKeyCartItems = $this->sessionKey . '_cart_items';
|
||||
$this->sessionKeyCartConditions = $this->sessionKey . '_cart_conditions';
|
||||
public function getSessionKey(): string
|
||||
{
|
||||
return $this->session->getSessionKey();
|
||||
}
|
||||
|
||||
return $this;
|
||||
public function setSessionKey(string $sessionKey): void
|
||||
{
|
||||
$this->session->setSessionKey($sessionKey);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -109,20 +78,16 @@ public function getInstanceName()
|
||||
|
||||
/**
|
||||
* get an item on a cart by item ID
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function get($itemId)
|
||||
public function get($itemId): ?ItemCollection
|
||||
{
|
||||
return $this->getContent()->get($itemId);
|
||||
}
|
||||
|
||||
/**
|
||||
* check if an item exists by item ID
|
||||
*
|
||||
* @return bool
|
||||
* check if we have this item in the cart by item ID
|
||||
*/
|
||||
public function has($itemId)
|
||||
public function has($itemId): bool
|
||||
{
|
||||
return $this->getContent()->has($itemId);
|
||||
}
|
||||
@@ -131,29 +96,28 @@ public function has($itemId)
|
||||
* add item to the cart, it can be an array or multi dimensional array
|
||||
*
|
||||
* @param string|array $id
|
||||
* @param string $name
|
||||
* @param float $price
|
||||
* @param int $quantity
|
||||
* @param array $attributes
|
||||
* @param CartCondition|array $conditions
|
||||
* @param string $associatedModel
|
||||
* @return $this
|
||||
*
|
||||
* @throws InvalidItemException
|
||||
*/
|
||||
public function add($id, $name = null, $price = null, $quantity = null, $attributes = [], $conditions = [], $associatedModel = null)
|
||||
{
|
||||
// if the first argument is an array,
|
||||
// we will need to call add again
|
||||
public function add(
|
||||
string|int|array $id,
|
||||
?string $name = null,
|
||||
?float $price = null,
|
||||
int|float|null $quantity = null,
|
||||
array $attributes = [],
|
||||
array|CartCondition $conditions = [],
|
||||
?string $associatedModel = null
|
||||
): self {
|
||||
// check if we are adding an array of items
|
||||
if (is_array($id)) {
|
||||
// the first argument is an array, now we will need to check if it is a multi dimensional
|
||||
// array, if so, we will iterate through each item and call add again
|
||||
// check if we are adding a multi dimensional array
|
||||
if (Helpers::isMultiArray($id)) {
|
||||
foreach ($id as $item) {
|
||||
$this->add(
|
||||
$item['id'],
|
||||
$item['name'],
|
||||
$item['price'],
|
||||
isset($item['price']) ? $item['price'] : null,
|
||||
$item['quantity'],
|
||||
Helpers::issetAndHasValueOrAssignDefault($item['attributes'], []),
|
||||
Helpers::issetAndHasValueOrAssignDefault($item['conditions'], []),
|
||||
@@ -164,7 +128,7 @@ public function add($id, $name = null, $price = null, $quantity = null, $attribu
|
||||
$this->add(
|
||||
$id['id'],
|
||||
$id['name'],
|
||||
$id['price'],
|
||||
isset($id['price']) ? $id['price'] : null,
|
||||
$id['quantity'],
|
||||
Helpers::issetAndHasValueOrAssignDefault($id['attributes'], []),
|
||||
Helpers::issetAndHasValueOrAssignDefault($id['conditions'], []),
|
||||
@@ -175,6 +139,7 @@ public function add($id, $name = null, $price = null, $quantity = null, $attribu
|
||||
return $this;
|
||||
}
|
||||
|
||||
// if we are here, we are adding a single item
|
||||
$data = [
|
||||
'id' => $id,
|
||||
'name' => $name,
|
||||
@@ -191,11 +156,8 @@ public function add($id, $name = null, $price = null, $quantity = null, $attribu
|
||||
// validate data
|
||||
$item = $this->validate($data);
|
||||
|
||||
// get the cart
|
||||
$cart = $this->getContent();
|
||||
|
||||
// if the item is already in the cart we will just update it
|
||||
if ($cart->has($id)) {
|
||||
if ($this->get($id)) {
|
||||
$this->update($id, $item);
|
||||
} else {
|
||||
$this->addItem($id, $item);
|
||||
@@ -203,21 +165,37 @@ public function add($id, $name = null, $price = null, $quantity = null, $attribu
|
||||
|
||||
$this->currentItemId = $id;
|
||||
|
||||
// clean up any incomplete items
|
||||
$this->removeInvalidItems();
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* update a cart
|
||||
*
|
||||
* @param array $data
|
||||
*
|
||||
* the $data will be an associative array, you don't need to pass all the data, only the key value
|
||||
* of the item you want to update on it
|
||||
* @return bool
|
||||
* Remove any incomplete items
|
||||
*/
|
||||
public function update($id, $data)
|
||||
public function removeInvalidItems(): bool
|
||||
{
|
||||
if ($this->fireEvent('updating', $data) === false) {
|
||||
$carts = $this->getContent();
|
||||
|
||||
foreach ($carts as $index => $cart) {
|
||||
|
||||
if (! (isset($cart['id'], $cart['name'], $cart['quantity']))) {
|
||||
|
||||
// remove item
|
||||
$this->remove($index);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a cart item with whatever data is passed in
|
||||
*/
|
||||
public function update(int|string $id, array $data): bool
|
||||
{
|
||||
if ($this->fireEvent('Updating', 'item', $data) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -250,7 +228,7 @@ public function update($id, $data)
|
||||
|
||||
$this->save($cart);
|
||||
|
||||
$this->fireEvent('updated', $item);
|
||||
$this->fireEvent('Updated', 'item', $item);
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -309,7 +287,7 @@ public function remove($id)
|
||||
{
|
||||
$cart = $this->getContent();
|
||||
|
||||
if ($this->fireEvent('removing', $id) === false) {
|
||||
if ($this->fireEvent('Removing', 'item', $id) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -317,41 +295,46 @@ public function remove($id)
|
||||
|
||||
$this->save($cart);
|
||||
|
||||
$this->fireEvent('removed', $id);
|
||||
$this->fireEvent('Removed', 'item', $id);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* clear cart
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function clear()
|
||||
{
|
||||
if ($this->fireEvent('clearing') === false) {
|
||||
if ($this->fireEvent('Clearing') === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->session->put(
|
||||
$this->sessionKeyCartItems,
|
||||
[]
|
||||
);
|
||||
$this->session->clear();
|
||||
|
||||
$this->fireEvent('cleared');
|
||||
$this->fireEvent('Cleared');
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public function clearItems()
|
||||
{
|
||||
if ($this->fireEvent('Clearing') === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->session->clearItems();
|
||||
|
||||
$this->fireEvent('Cleared');
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* add a condition on the cart
|
||||
*
|
||||
* @param CartCondition|array $condition
|
||||
* @return $this
|
||||
* Adds a condition to the cart
|
||||
*/
|
||||
/**
|
||||
* Adds a condition to the cart
|
||||
*
|
||||
* @throws InvalidConditionException
|
||||
*/
|
||||
public function condition(CartCondition $condition)
|
||||
public function condition(array|CartCondition $condition): self
|
||||
{
|
||||
if (is_array($condition)) {
|
||||
foreach ($condition as $c) {
|
||||
@@ -375,7 +358,9 @@ public function condition(CartCondition $condition)
|
||||
|
||||
$conditions->put($condition->getName(), $condition);
|
||||
|
||||
$conditions = $conditions->sortBy(function ($condition, $key) {
|
||||
$conditions = $conditions->reject(function ($condition) {
|
||||
return empty($condition);
|
||||
})->sortBy(function ($condition, $key) {
|
||||
return $condition->getOrder();
|
||||
});
|
||||
|
||||
@@ -387,11 +372,34 @@ public function condition(CartCondition $condition)
|
||||
/**
|
||||
* get conditions applied on the cart
|
||||
*
|
||||
* @return CartConditionCollection
|
||||
* @param bool $active - If true, only conditions actually applied on the cart are returned
|
||||
*/
|
||||
public function getConditions()
|
||||
public function getConditions(bool $array = false, bool $active = false): CartConditionCollection|array
|
||||
{
|
||||
return new CartConditionCollection($this->session->get($this->sessionKeyCartConditions));
|
||||
$conditions = new CartConditionCollection($this->session->getConditions());
|
||||
|
||||
$conditions = $conditions->reject(function ($condition) {
|
||||
return empty($condition);
|
||||
})
|
||||
->transform(function ($condition) {
|
||||
return $condition instanceof CartCondition ? $condition : new CartCondition($condition);
|
||||
});
|
||||
|
||||
if ($active) {
|
||||
return $conditions->filter(function (CartCondition $condition) {
|
||||
$amount = $condition->getTarget() == 'subtotal' ? $this->getSubTotal(false) : $this->getTotal();
|
||||
|
||||
return $condition->getMinimum() === null || $condition->getMinimum() <= $amount;
|
||||
})->filter(function (CartCondition $condition) {
|
||||
$amount = $condition->getTarget() == 'subtotal' ? $this->getSubTotal(false) : $this->getTotal();
|
||||
|
||||
return $condition->getMaximum() === null || $condition->getMaximum() >= $amount;
|
||||
});
|
||||
}
|
||||
|
||||
return $array ? $conditions->map(function (CartCondition $condition) {
|
||||
return $condition->toArray();
|
||||
})->toArray() : $conditions;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -420,12 +428,8 @@ public function getConditionsByType($type)
|
||||
|
||||
/**
|
||||
* Remove all the condition with the $type specified
|
||||
* Please Note that this will only remove condition added on cart bases, not those conditions added
|
||||
* specifically on an per item bases
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function removeConditionsByType($type)
|
||||
public function removeConditionsByType(string $type)
|
||||
{
|
||||
$this->getConditionsByType($type)->each(function ($condition) {
|
||||
$this->removeCartCondition($condition->getName());
|
||||
@@ -433,12 +437,7 @@ public function removeConditionsByType($type)
|
||||
}
|
||||
|
||||
/**
|
||||
* removes a condition on a cart by condition name,
|
||||
* this can only remove conditions that are added on cart bases not conditions that are added on an item/product.
|
||||
* If you wish to remove a condition that has been added for a specific item/product, you may
|
||||
* use the removeItemCondition(itemId, conditionName) method instead.
|
||||
*
|
||||
* @return void
|
||||
* Remove a condition from the cart
|
||||
*/
|
||||
public function removeCartCondition($conditionName)
|
||||
{
|
||||
@@ -524,18 +523,25 @@ public function clearItemConditions($itemId)
|
||||
}
|
||||
|
||||
/**
|
||||
* clears all conditions on a cart,
|
||||
* this does not remove conditions that has been added specifically to an item/product.
|
||||
* If you wish to remove a specific condition to a product, you may use the method: removeItemCondition($itemId, $conditionName)
|
||||
*
|
||||
* @return void
|
||||
* Clear cart conditions (this does not clear item conditions)
|
||||
*/
|
||||
public function clearCartConditions()
|
||||
public function clearCartConditions(): void
|
||||
{
|
||||
$this->session->put(
|
||||
$this->sessionKeyCartConditions,
|
||||
[]
|
||||
);
|
||||
$this->session->putConditions([]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all conditions from all items and the cart
|
||||
*/
|
||||
public function clearAllConditions(): void
|
||||
{
|
||||
$cart = $this->getContent();
|
||||
|
||||
$cart->each(function ($item) {
|
||||
$this->clearItemConditions($item->id);
|
||||
});
|
||||
|
||||
$this->clearCartConditions();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -555,14 +561,10 @@ public function getSubTotalWithoutConditions($formatted = true)
|
||||
return Helpers::formatValue(floatval($sum), $formatted, $this->config);
|
||||
}
|
||||
|
||||
/**
|
||||
* get cart sub total
|
||||
*
|
||||
* @param bool $formatted
|
||||
*/
|
||||
public function getSubTotal($formatted = true): int|float|string
|
||||
{
|
||||
$subTotal = 0.00;
|
||||
|
||||
// add all the items together with conditions applied
|
||||
$subTotalSum = $this->getContent()->sum(function (ItemCollection $item) {
|
||||
return $item->getPriceSumWithConditions(false);
|
||||
@@ -574,6 +576,12 @@ public function getSubTotal($formatted = true): int|float|string
|
||||
->filter(function (CartCondition $condition) {
|
||||
return $condition->getTarget() === 'subtotal';
|
||||
})
|
||||
->filter(function (CartCondition $condition) use ($subTotalSum) {
|
||||
return $condition->getMinimum() === null || $condition->getMinimum() <= $subTotalSum;
|
||||
})
|
||||
->filter(function (CartCondition $condition) use ($subTotalSum) {
|
||||
return $condition->getMaximum() === null || $condition->getMaximum() >= $subTotalSum;
|
||||
})
|
||||
->sortBy(function (CartCondition $condition) {
|
||||
return $condition->getOrder();
|
||||
});
|
||||
@@ -606,6 +614,15 @@ public function getTotal(): int|float
|
||||
$conditionsForTotal = $this->getConditions()
|
||||
->filter(function (CartCondition $condition) {
|
||||
return $condition->getTarget() === 'total';
|
||||
})
|
||||
->filter(function (CartCondition $condition) use ($subTotal) {
|
||||
return $condition->getMinimum() === null || $condition->getMinimum() <= $subTotal;
|
||||
})
|
||||
->filter(function (CartCondition $condition) use ($subTotal) {
|
||||
return $condition->getMaximum() === null || $condition->getMaximum() >= $subTotal;
|
||||
})
|
||||
->sortBy(function (CartCondition $condition) {
|
||||
return $condition->getOrder();
|
||||
});
|
||||
|
||||
// if no conditions were added, just return the sub total
|
||||
@@ -613,10 +630,14 @@ public function getTotal(): int|float
|
||||
return Helpers::formatValue($subTotal, $this->config['format_numbers'], $this->config);
|
||||
}
|
||||
|
||||
$conditionsForTotal->each(function (CartCondition $condition) use ($subTotal, &$total) {
|
||||
$toBeCalculated = $total > 0 ? $total : $subTotal;
|
||||
$index = 0;
|
||||
|
||||
$conditionsForTotal->each(function (CartCondition $condition) use ($subTotal, &$total, &$index) {
|
||||
$toBeCalculated = ($index > 0) ? $total : $subTotal;
|
||||
|
||||
$total = $condition->applyCondition($toBeCalculated);
|
||||
|
||||
$index++;
|
||||
});
|
||||
|
||||
return Helpers::formatValue($total, $this->config['format_numbers'], $this->config);
|
||||
@@ -664,24 +685,16 @@ public function getTotalQuantity()
|
||||
return $count;
|
||||
}
|
||||
|
||||
/**
|
||||
* get the cart
|
||||
*
|
||||
* @return CartCollection
|
||||
*/
|
||||
public function getContent()
|
||||
public function getContent(): CartCollection
|
||||
{
|
||||
return (new CartCollection($this->session->get($this->sessionKeyCartItems)))->reject(function ($item) {
|
||||
return (new CartCollection($this->session->getItems()))->transform(function ($item) {
|
||||
return $item instanceof ItemCollection ? $item : new ItemCollection($item, $this->config);
|
||||
})->reject(function ($item) {
|
||||
return ! ($item instanceof ItemCollection);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* check if cart is empty
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isEmpty()
|
||||
public function isEmpty($test = null)
|
||||
{
|
||||
return $this->getContent()->isEmpty();
|
||||
}
|
||||
@@ -697,15 +710,24 @@ protected function validate($item)
|
||||
{
|
||||
$rules = [
|
||||
'id' => 'required',
|
||||
'price' => 'required|numeric',
|
||||
'quantity' => 'required|numeric|min:0.1',
|
||||
'name' => 'required',
|
||||
'quantity' => 'required|numeric|min:0.1',
|
||||
];
|
||||
|
||||
$validator = CartItemValidator::make($item, $rules);
|
||||
|
||||
if ($validator->fails()) {
|
||||
throw new InvalidItemException($validator->messages()->first());
|
||||
if ($validator->errors()->first('id') === 'validation.required') {
|
||||
throw new InvalidItemException('The id field is required.');
|
||||
}
|
||||
|
||||
if ($validator->errors()->first('name') === 'validation.required') {
|
||||
throw new InvalidItemException('The name field is required.');
|
||||
}
|
||||
|
||||
if ($validator->errors()->first('quantity') === 'validation.min.numeric') {
|
||||
throw new InvalidItemException('The quantity must be at least 0.1.');
|
||||
}
|
||||
}
|
||||
|
||||
return $item;
|
||||
@@ -718,7 +740,7 @@ protected function validate($item)
|
||||
*/
|
||||
protected function addItem($id, $item)
|
||||
{
|
||||
if ($this->fireEvent('adding', $item) === false) {
|
||||
if ($this->fireEvent('Adding', 'item', $item) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -728,7 +750,7 @@ protected function addItem($id, $item)
|
||||
|
||||
$this->save($cart);
|
||||
|
||||
$this->fireEvent('added', $item);
|
||||
$this->fireEvent('Added', 'item', $item);
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -740,7 +762,7 @@ protected function addItem($id, $item)
|
||||
*/
|
||||
protected function save($cart)
|
||||
{
|
||||
$this->session->put($this->sessionKeyCartItems, $cart);
|
||||
$this->session->putItems($cart);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -748,7 +770,7 @@ protected function save($cart)
|
||||
*/
|
||||
protected function saveConditions($conditions)
|
||||
{
|
||||
$this->session->put($this->sessionKeyCartConditions, $conditions);
|
||||
$this->session->putConditions($conditions);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -819,12 +841,19 @@ public function setDecimals($decimals)
|
||||
$this->decimals = $decimals;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
protected function fireEvent($name, $value = [])
|
||||
protected function fireEvent($name, $type = null, $data = null)
|
||||
{
|
||||
return $this->events->dispatch($this->getInstanceName() . '.' . $name, array_values([$value, $this]), true);
|
||||
$eventData = [
|
||||
'session_key' => $this->session->sessionKey,
|
||||
'session_driver' => $this->session->driver,
|
||||
'session_model' => $this->session->getSessionModel(),
|
||||
];
|
||||
|
||||
if ($type) {
|
||||
$eventData[$type] = $data;
|
||||
}
|
||||
|
||||
return $this->events->dispatch('LaravelCart.' . $name, array_values([$eventData, $this]), true);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
+22
-10
@@ -8,15 +8,12 @@
|
||||
|
||||
class CartCondition
|
||||
{
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
private $args;
|
||||
|
||||
/**
|
||||
* the parsed raw value of the condition
|
||||
*/
|
||||
public $parsedRawValue = 0;
|
||||
private $parsedRawValue = 0;
|
||||
|
||||
/**
|
||||
* @param array $args (name, type, target, value)
|
||||
@@ -65,6 +62,22 @@ public function getType()
|
||||
return $this->args['type'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the minimum value of this condition
|
||||
*/
|
||||
public function getMinimum(): int|float|null
|
||||
{
|
||||
return $this->args['minimum'] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the maximum value of this condition
|
||||
*/
|
||||
public function getMaximum(): int|float|null
|
||||
{
|
||||
return $this->args['maximum'] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* get the additional attributes of a condition
|
||||
*
|
||||
@@ -145,12 +158,6 @@ public function getCalculatedValue($totalOrSubTotalOrPrice = null): int|float
|
||||
*/
|
||||
protected function apply($totalOrSubTotalOrPrice, $conditionValue)
|
||||
{
|
||||
if ($totalOrSubTotalOrPrice <= 0) {
|
||||
$this->parsedRawValue = 0;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// if value has a percentage sign on it, we will get first
|
||||
// its percentage then we will evaluate again if the value
|
||||
// has a minus or plus sign so we can decide what to do with the
|
||||
@@ -259,4 +266,9 @@ protected function validate($args)
|
||||
throw new InvalidConditionException($validator->messages()->first());
|
||||
}
|
||||
}
|
||||
|
||||
public function toArray(): array
|
||||
{
|
||||
return $this->args;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -35,24 +35,19 @@ public function register()
|
||||
$this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'cart');
|
||||
|
||||
$this->app->singleton('cart', function ($app) {
|
||||
$storageClass = config('cart.storage');
|
||||
$eventsClass = config('cart.events');
|
||||
$config = config('cart');
|
||||
$events = $app['events'];
|
||||
|
||||
$storage = $storageClass ? new $storageClass : $app['session'];
|
||||
$events = $eventsClass ? new $eventsClass : $app['events'];
|
||||
$instanceName = 'cart';
|
||||
|
||||
// default session or cart identifier. This will be overridden when calling Cart::session($sessionKey)->add() etc..
|
||||
// like when adding a cart for a specific user name. Session Key can be string or maybe a unique identifier to bind a cart
|
||||
// to a specific user, this can also be a user ID
|
||||
$session_key = '4yTlTDKu3oJOfzD';
|
||||
$storage = $config['driver'] === 'database'
|
||||
? new $config['storage']['database']['model']
|
||||
: $app['session'];
|
||||
|
||||
return new Cart(
|
||||
$storage,
|
||||
$events,
|
||||
$instanceName,
|
||||
$session_key,
|
||||
config('cart')
|
||||
'cart',
|
||||
session()->getId(),
|
||||
$config
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
@@ -0,0 +1,174 @@
|
||||
<?php
|
||||
|
||||
namespace Wearepixel\Cart;
|
||||
|
||||
class CartSession
|
||||
{
|
||||
private $customStorage;
|
||||
|
||||
public $sessionKey;
|
||||
public $driver;
|
||||
|
||||
private $session;
|
||||
|
||||
private $sessionId = null;
|
||||
private $itemsKey = null;
|
||||
private $conditionsKey = null;
|
||||
|
||||
public function __construct($session, $sessionKey, $config)
|
||||
{
|
||||
$this->sessionKey = $sessionKey;
|
||||
$this->driver = $config['driver'];
|
||||
|
||||
if ($this->driver === 'session') {
|
||||
$this->customStorage = false;
|
||||
$this->session = $session;
|
||||
$this->itemsKey = $this->sessionKey . '_cart_items';
|
||||
$this->conditionsKey = $this->sessionKey . '_cart_conditions';
|
||||
} elseif ($this->driver === 'database') {
|
||||
$this->customStorage = true;
|
||||
|
||||
$this->sessionId = $config['storage']['database']['id'];
|
||||
$this->itemsKey = $config['storage']['database']['items'];
|
||||
$this->conditionsKey = $config['storage']['database']['conditions'];
|
||||
|
||||
$this->session = $session->firstOrNew([$this->sessionId => $this->sessionKey]);
|
||||
|
||||
$this->session[$this->itemsKey] = $this->session[$this->itemsKey] ?? [];
|
||||
$this->session[$this->conditionsKey] = $this->session[$this->conditionsKey] ?? [];
|
||||
}
|
||||
}
|
||||
|
||||
public function isInternalSession($session)
|
||||
{
|
||||
return in_array(is_object($session) ? get_class($session) : $session, [
|
||||
'Illuminate\Session\SessionManager',
|
||||
'Wearepixel\Cart\Tests\Helpers\SessionMock',
|
||||
]);
|
||||
}
|
||||
|
||||
public function getSessionKey()
|
||||
{
|
||||
return $this->sessionKey;
|
||||
}
|
||||
|
||||
public function setSessionKey(string $sessionKey)
|
||||
{
|
||||
// set the session key and then update the session
|
||||
$this->sessionKey = $sessionKey;
|
||||
|
||||
if ($this->driver == 'session') {
|
||||
$session = $this->session->get($this->itemsKey);
|
||||
$sessionKey = $this->session->get($this->conditionsKey);
|
||||
|
||||
$this->session->forget($this->itemsKey);
|
||||
$this->session->forget($this->conditionsKey);
|
||||
|
||||
$this->itemsKey = $this->sessionKey . '_cart_items';
|
||||
$this->conditionsKey = $this->sessionKey . '_cart_conditions';
|
||||
|
||||
$this->session->put($this->itemsKey, $session);
|
||||
$this->session->put($this->conditionsKey, $sessionKey);
|
||||
} elseif ($this->driver == 'database') {
|
||||
$this->session[$this->sessionId] = $sessionKey;
|
||||
$this->session->save();
|
||||
}
|
||||
}
|
||||
|
||||
public function has($key)
|
||||
{
|
||||
return $this->session->has($key) ?? $this->session;
|
||||
}
|
||||
|
||||
public function getItems()
|
||||
{
|
||||
return $this->driver == 'session' ? $this->session->get($this->itemsKey) : $this->session[$this->itemsKey];
|
||||
}
|
||||
|
||||
public function getConditions()
|
||||
{
|
||||
return $this->driver == 'session' ? $this->session->get($this->conditionsKey) : $this->session[$this->conditionsKey];
|
||||
}
|
||||
|
||||
public function putItems($value)
|
||||
{
|
||||
if ($this->driver == 'session') {
|
||||
return $this->session->put($this->itemsKey, $value);
|
||||
}
|
||||
|
||||
// convert any conditions to arrays
|
||||
$value = is_array($value) ? $value : $value->toArray();
|
||||
|
||||
foreach ($value as $key => $item) {
|
||||
if ($item['conditions']) {
|
||||
if (is_array($item['conditions'])) {
|
||||
$value[$key]['conditions'] = collect($item['conditions'])->map(function ($condition) {
|
||||
return $condition->toArray();
|
||||
});
|
||||
} else {
|
||||
$value[$key]['conditions'] = $item['conditions']->toArray();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->session[$this->itemsKey] = $value;
|
||||
$this->session->save();
|
||||
|
||||
return $this->session;
|
||||
}
|
||||
|
||||
public function putConditions($value)
|
||||
{
|
||||
if ($this->driver == 'session') {
|
||||
return $this->session->put($this->conditionsKey, $value);
|
||||
}
|
||||
|
||||
if (! empty($value)) {
|
||||
$value = $value->mapWithKeys(function ($condition) {
|
||||
return [$condition->getName() => $condition->toArray()];
|
||||
});
|
||||
}
|
||||
|
||||
$this->session[$this->conditionsKey] = $value;
|
||||
$this->session->save();
|
||||
|
||||
return $this->session;
|
||||
}
|
||||
|
||||
public function clearItems()
|
||||
{
|
||||
if ($this->driver == 'session') {
|
||||
$this->session->forget($this->itemsKey);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
$this->session[$this->itemsKey] = [];
|
||||
|
||||
return $this->session->save();
|
||||
}
|
||||
|
||||
public function clear()
|
||||
{
|
||||
if ($this->driver == 'session') {
|
||||
$this->session->forget($this->itemsKey);
|
||||
$this->session->forget($this->conditionsKey);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
$deleted = $this->session->delete();
|
||||
|
||||
$this->session = [
|
||||
$this->itemsKey => [],
|
||||
$this->conditionsKey => [],
|
||||
];
|
||||
|
||||
return $deleted;
|
||||
}
|
||||
|
||||
public function getSessionModel()
|
||||
{
|
||||
return $this->session;
|
||||
}
|
||||
}
|
||||
@@ -3,10 +3,40 @@
|
||||
namespace Wearepixel\Cart\Facades;
|
||||
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
use Wearepixel\Cart\Cart;
|
||||
use Wearepixel\Cart\CartCollection;
|
||||
use Wearepixel\Cart\CartCondition;
|
||||
use Wearepixel\Cart\CartConditionCollection;
|
||||
use Wearepixel\Cart\ItemCollection;
|
||||
|
||||
/**
|
||||
* @mixin Cart
|
||||
*
|
||||
* @method static ItemCollection|null get(int|string $itemId)
|
||||
* @method static bool has(int|string $itemId)
|
||||
* @method static self add(string|int|array<string, mixed> $id, string|null $name = null, float|null $price = null, int|float|null $quantity = null, array<string, mixed> $attributes = [], CartCondition|array<mixed> $conditions = [], string|null $associatedModel = null)
|
||||
* @method static bool update(int|string $id, array $data)
|
||||
* @method static void remove(int|string $id)
|
||||
* @method static void clear()
|
||||
* @method static void clearItems()
|
||||
* @method static Cart condition(array|CartCondition $condition)
|
||||
* @method static CartConditionCollection|array getConditions(bool $array = false, bool $active = false)
|
||||
* @method static CartCondition|null getCondition(string $conditionName)
|
||||
* @method static CartConditionCollection getConditionsByType(string $type)
|
||||
* @method static void removeConditionsByType(string $type)
|
||||
* @method static void removeCartCondition(string $conditionName)
|
||||
* @method static void clearItemConditions(int|string $itemId)
|
||||
* @method static void clearAllConditions()
|
||||
* @method static CartCollection getContent()
|
||||
* @method static bool isEmpty()
|
||||
* @method static int getTotalQuantity()
|
||||
* @method static int|float|string getSubTotal(bool $formatted = true)
|
||||
* @method static int|float|string getSubTotalWithoutConditions(bool $formatted = true)
|
||||
* @method static int|float getTotal()
|
||||
*/
|
||||
class CartFacade extends Facade
|
||||
{
|
||||
protected static function getFacadeAccessor()
|
||||
protected static function getFacadeAccessor(): string
|
||||
{
|
||||
return 'cart';
|
||||
}
|
||||
|
||||
+6
-10
@@ -7,7 +7,7 @@ class Helpers
|
||||
/**
|
||||
* Normalize prices
|
||||
*/
|
||||
public static function normalizePrice($price): float
|
||||
public static function normalizePrice($price): ?float
|
||||
{
|
||||
return (is_string($price)) ? floatval($price) : $price;
|
||||
}
|
||||
@@ -25,15 +25,10 @@ public static function roundMode($config): int
|
||||
}
|
||||
|
||||
/**
|
||||
* check if array is multi dimensional array
|
||||
* This will only check the first element of the array if it is still an array
|
||||
* to decide that it is a multi dimensional, if you want to check the array strictly
|
||||
* with all on its element, flag the second argument as true
|
||||
*
|
||||
* @param bool $recursive
|
||||
* @return bool
|
||||
* Check if array is multi dimensional array
|
||||
* This will only check if the first element of the array is an array
|
||||
*/
|
||||
public static function isMultiArray($array, $recursive = false)
|
||||
public static function isMultiArray(array $array, bool $recursive = false): bool
|
||||
{
|
||||
if ($recursive) {
|
||||
return (count($array) == count($array, COUNT_RECURSIVE)) ? false : true;
|
||||
@@ -45,8 +40,9 @@ public static function isMultiArray($array, $recursive = false)
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
+34
-4
@@ -91,7 +91,37 @@ public function getConditions()
|
||||
return [];
|
||||
}
|
||||
|
||||
return $this['conditions'];
|
||||
$conditionsArray = [];
|
||||
|
||||
$conditions = $this['conditions'];
|
||||
|
||||
// check if we're already an array of CartConditions
|
||||
foreach ($conditions as $key => $condition) {
|
||||
if ($condition instanceof CartCondition) {
|
||||
return $conditions;
|
||||
}
|
||||
}
|
||||
|
||||
$hasSubArray = false;
|
||||
|
||||
foreach ($conditions as $key => $condition) {
|
||||
if (is_array($condition) && ! $condition instanceof CartCondition) {
|
||||
$hasSubArray = true;
|
||||
$conditionsArray[] = new CartCondition($condition);
|
||||
} elseif ($condition instanceof CartCondition) {
|
||||
$conditionsArray[] = $condition;
|
||||
}
|
||||
}
|
||||
|
||||
if (! $hasSubArray) {
|
||||
if ($conditions instanceof CartCondition) {
|
||||
return $conditions;
|
||||
}
|
||||
|
||||
$conditionsArray[] = new CartCondition($conditions);
|
||||
}
|
||||
|
||||
return $conditionsArray;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -108,14 +138,14 @@ public function getPriceWithConditions($formatted = true)
|
||||
$processed = 0;
|
||||
|
||||
if ($this->hasConditions()) {
|
||||
if (is_array($this->conditions)) {
|
||||
foreach ($this->conditions as $condition) {
|
||||
if (is_array($this->getConditions())) {
|
||||
foreach ($this->getConditions() as $condition) {
|
||||
($processed > 0) ? $toBeCalculated = $newPrice : $toBeCalculated = $originalPrice;
|
||||
$newPrice = $condition->applyCondition($toBeCalculated);
|
||||
$processed++;
|
||||
}
|
||||
} else {
|
||||
$newPrice = $this['conditions']->applyCondition($originalPrice);
|
||||
$newPrice = $this->getConditions()->applyCondition($originalPrice);
|
||||
}
|
||||
|
||||
return Helpers::formatValue($newPrice, $formatted, $this->config);
|
||||
|
||||
@@ -4,6 +4,5 @@
|
||||
'format_numbers' => true,
|
||||
'decimals' => 2,
|
||||
'dec_point' => '.',
|
||||
'thousands_sep' => ',',
|
||||
'use_cents' => false,
|
||||
'driver' => 'session',
|
||||
];
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
|
||||
return [
|
||||
'format_numbers' => true,
|
||||
'decimals' => 2,
|
||||
'round_mode' => 'up',
|
||||
'driver' => 'database',
|
||||
'storage' => [
|
||||
'session',
|
||||
'database' => [
|
||||
'model' => \Wearepixel\Cart\Tests\Helpers\MockCartModel::class,
|
||||
'id' => 'session_id',
|
||||
'items' => 'items',
|
||||
'conditions' => 'conditions',
|
||||
],
|
||||
],
|
||||
];
|
||||
@@ -4,4 +4,5 @@
|
||||
'format_numbers' => true,
|
||||
'decimals' => 2,
|
||||
'round_mode' => 'up',
|
||||
'driver' => 'session',
|
||||
];
|
||||
|
||||
@@ -4,5 +4,5 @@
|
||||
'format_numbers' => false,
|
||||
'decimals' => 3,
|
||||
'dec_point' => ',',
|
||||
'thousands_sep' => '.',
|
||||
'driver' => 'session',
|
||||
];
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
namespace Wearepixel\Cart\Tests\Helpers;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class MockCartModel extends Model
|
||||
{
|
||||
protected $fillable = [
|
||||
'session_id',
|
||||
'items',
|
||||
'conditions',
|
||||
];
|
||||
|
||||
public $timestamps = false;
|
||||
|
||||
protected $casts = [
|
||||
'items' => 'array',
|
||||
'conditions' => 'array',
|
||||
];
|
||||
|
||||
protected $table = 'carts';
|
||||
}
|
||||
@@ -20,4 +20,9 @@ public function put($key, $value)
|
||||
{
|
||||
$this->session[$key] = $value;
|
||||
}
|
||||
|
||||
public function forget($key)
|
||||
{
|
||||
unset($this->session[$key]);
|
||||
}
|
||||
}
|
||||
|
||||
+2
-26
@@ -1,29 +1,5 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Test Case
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| The closure you provide to your test functions is always bound to a specific PHPUnit test
|
||||
| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
|
||||
| need to change it using the "pest()" function to bind a different classes or traits.
|
||||
|
|
||||
*/
|
||||
use Tests\TestCase;
|
||||
|
||||
// pest()->extend(Tests\TestCase::class)->in('Feature');
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Expectations
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| When you're writing tests, you often need to check that values meet certain conditions. The
|
||||
| "expect()" function gives you access to a set of "expectations" methods that you can use
|
||||
| to assert different things. Of course, you may extend the Expectation API at any time.
|
||||
|
|
||||
*/
|
||||
|
||||
expect()->extend('toBeOne', function () {
|
||||
return $this->toBe(1);
|
||||
});
|
||||
uses(TestCase::class)->in(__DIR__);
|
||||
|
||||
+44
-2
@@ -1,10 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests;
|
||||
|
||||
use Illuminate\Events\Dispatcher;
|
||||
use Illuminate\Container\Container;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Database\Capsule\Manager as DB;
|
||||
use PHPUnit\Framework\TestCase as BaseTestCase;
|
||||
|
||||
abstract class TestCase extends BaseTestCase
|
||||
class TestCase extends BaseTestCase
|
||||
{
|
||||
//
|
||||
protected DB $db;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
// Create a Laravel container
|
||||
$container = Container::getInstance();
|
||||
$dispatcher = new Dispatcher;
|
||||
|
||||
// Setup Capsule (Eloquent ORM)
|
||||
$this->db = new DB($container);
|
||||
$this->db->addConnection([
|
||||
'driver' => 'sqlite',
|
||||
'database' => ':memory:',
|
||||
'prefix' => '',
|
||||
]);
|
||||
$this->db->setAsGlobal();
|
||||
$this->db->bootEloquent();
|
||||
$this->db->getConnection()->setEventDispatcher($dispatcher);
|
||||
|
||||
// Run migrations (optional, for testing models)
|
||||
$this->migrateDatabase();
|
||||
}
|
||||
|
||||
protected function migrateDatabase()
|
||||
{
|
||||
$schema = $this->db->schema();
|
||||
|
||||
$schema->create('carts', function (Blueprint $table) {
|
||||
$table->id();
|
||||
$table->string('session_id');
|
||||
$table->text('items');
|
||||
$table->text('conditions');
|
||||
$table->timestamps();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
+549
-170
@@ -2,6 +2,7 @@
|
||||
|
||||
use Wearepixel\Cart\Cart;
|
||||
use Wearepixel\Cart\CartCondition;
|
||||
use Wearepixel\Cart\CartConditionCollection;
|
||||
use Wearepixel\Cart\Tests\Helpers\SessionMock;
|
||||
|
||||
beforeEach(function () {
|
||||
@@ -21,7 +22,168 @@
|
||||
Mockery::close();
|
||||
});
|
||||
|
||||
describe('conditions', function () {
|
||||
test('can be completely cleared', function () {
|
||||
$siteWideDiscount = new CartCondition([
|
||||
'name' => 'Site Wide Discount',
|
||||
'type' => 'discount',
|
||||
'target' => 'total',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$giftCard = new CartCondition([
|
||||
'name' => 'Gift Card',
|
||||
'type' => 'gift_card',
|
||||
'target' => 'total',
|
||||
'value' => '-25',
|
||||
]);
|
||||
|
||||
$itemCondition = new CartCondition([
|
||||
'name' => 'Item Discount',
|
||||
'type' => 'discount',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 1,
|
||||
'name' => 'Backpack',
|
||||
'price' => 168.72,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
'conditions' => [$itemCondition],
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
$this->cart->condition([$siteWideDiscount, $giftCard]);
|
||||
|
||||
expect($this->cart->getConditions()->count())->toEqual(2, 'Cart should have two conditions');
|
||||
expect($this->cart->get(1)['conditions'])->toHaveCount(1, 'Cart should have one condition');
|
||||
|
||||
$this->cart->clearAllConditions();
|
||||
|
||||
expect($this->cart->getConditions()->count())->toEqual(0, 'Cart should have no conditions now');
|
||||
expect($this->cart->get(1)['conditions'])->toHaveCount(0, 'Cart items should have no conditions now');
|
||||
});
|
||||
|
||||
test('can be converted to array', function () {
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Site Wide Discount',
|
||||
'type' => 'discount',
|
||||
'target' => 'total',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
$conditions = $this->cart->getConditions(true);
|
||||
|
||||
expect($conditions)->toHaveCount(1, 'Cart should have one condition');
|
||||
expect($conditions['Site Wide Discount'])->toEqual([
|
||||
'name' => 'Site Wide Discount',
|
||||
'type' => 'discount',
|
||||
'target' => 'total',
|
||||
'value' => '-5%',
|
||||
'order' => 1,
|
||||
]);
|
||||
});
|
||||
|
||||
test('can be removed by name', function () {
|
||||
$conditionOne = new CartCondition([
|
||||
'name' => '5% Site Wide Sale',
|
||||
'type' => 'sale',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$conditionTwo = new CartCondition([
|
||||
'name' => 'Mother\'s Day Gift Pack',
|
||||
'type' => 'promo',
|
||||
'value' => '-25',
|
||||
]);
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Body Scrub Kit',
|
||||
'price' => 100,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
$this->cart->condition([$conditionOne, $conditionTwo]);
|
||||
|
||||
// let's very first the item has 2 conditions in it
|
||||
expect($this->cart->getConditions())->toHaveCount(2, 'The item should have two conditions');
|
||||
|
||||
// now let's remove a condition on that item using the condition name
|
||||
$this->cart->removeCartCondition('5% Site Wide Sale');
|
||||
|
||||
// now we should have only 1 condition left on that item
|
||||
expect($this->cart->getConditions())->toHaveCount(1, 'Item should have one condition left');
|
||||
expect($this->cart->getConditions()->first()->getName())->toEqual('Mother\'s Day Gift Pack');
|
||||
});
|
||||
});
|
||||
|
||||
describe('cart level conditions', function () {
|
||||
test('can get conditions', function () {
|
||||
$this->cart->add([
|
||||
'id' => 456,
|
||||
'name' => 'Leather Shoes',
|
||||
'price' => 129.99,
|
||||
'quantity' => 1,
|
||||
]);
|
||||
|
||||
$condition = new CartCondition([
|
||||
'name' => '$5 Discount',
|
||||
'type' => 'tax',
|
||||
'target' => 'subtotal',
|
||||
'value' => '-5',
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
$conditions = $this->cart->getConditions();
|
||||
|
||||
expect($conditions)->toHaveCount(1, 'Cart should have one condition');
|
||||
expect($conditions)->toBeInstanceOf(CartConditionCollection::class);
|
||||
});
|
||||
|
||||
test('can get conditions by name', function () {
|
||||
$this->cart->add([
|
||||
'id' => 456,
|
||||
'name' => 'Leather Shoes',
|
||||
'price' => 129.99,
|
||||
'quantity' => 1,
|
||||
]);
|
||||
|
||||
$conditionOne = new CartCondition([
|
||||
'name' => '$5 Discount',
|
||||
'type' => 'tax',
|
||||
'target' => 'subtotal',
|
||||
'value' => '-5',
|
||||
]);
|
||||
|
||||
$conditionTwo = new CartCondition([
|
||||
'name' => '5% Off',
|
||||
'type' => 'tax',
|
||||
'target' => 'subtotal',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$this->cart->condition($conditionOne);
|
||||
$this->cart->condition($conditionTwo);
|
||||
|
||||
$conditions = $this->cart->getConditions();
|
||||
|
||||
expect($conditions)->toHaveCount(2, 'Cart should have two conditions');
|
||||
expect($conditions)->toBeInstanceOf(CartConditionCollection::class);
|
||||
|
||||
$condition = $this->cart->getCondition('5% Off');
|
||||
|
||||
expect($condition)->toBeInstanceOf(CartCondition::class);
|
||||
expect($condition->getName())->toEqual('5% Off');
|
||||
expect($condition->getValue())->toEqual('-5%');
|
||||
});
|
||||
|
||||
test('can discount the subtotal by dollar amount', function () {
|
||||
$this->cart->add([
|
||||
'id' => 456,
|
||||
@@ -791,10 +953,308 @@
|
||||
expect($couponDiscount->getCalculatedValue())->toEqual(200.0, 'Coupon Discount value should be 200.0');
|
||||
expect($giftCard->getCalculatedValue())->toEqual(0, 'Gift Card value should be 0');
|
||||
});
|
||||
|
||||
test('calculate the subtotal correctly when one condition makes it $0, and the other adds $10', function () {
|
||||
$this->cart->add([
|
||||
[
|
||||
'id' => 456,
|
||||
'name' => 'Sample Item 1',
|
||||
'price' => 67.99,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
[
|
||||
'id' => 568,
|
||||
'name' => 'Sample Item 2',
|
||||
'price' => 69.25,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
]);
|
||||
|
||||
expect($this->cart->getSubTotal())->toEqual(137.24, 'Cart should have sub total of 137.24');
|
||||
expect($this->cart->getTotal())->toEqual(137.24, 'Cart should have total of 137.24');
|
||||
|
||||
// add conditions
|
||||
$couponCode = new CartCondition([
|
||||
'name' => 'Coupon code',
|
||||
'type' => 'discount',
|
||||
'target' => 'subtotal',
|
||||
'order' => '1',
|
||||
'value' => '-100%',
|
||||
]);
|
||||
|
||||
$shipping = new CartCondition([
|
||||
'name' => 'Shipping',
|
||||
'type' => 'shipping',
|
||||
'target' => 'subtotal',
|
||||
'order' => '2',
|
||||
'value' => '10',
|
||||
]);
|
||||
|
||||
$this->cart->condition($couponCode);
|
||||
$this->cart->condition($shipping);
|
||||
|
||||
expect($this->cart->getSubTotal())->toEqual(10.00, 'Cart should have sub total of 10.00');
|
||||
expect($this->cart->getTotal())->toEqual(10.00, 'Cart should have a total of 10.00');
|
||||
});
|
||||
|
||||
test('calculate the subtotal correctly when one condition makes it $0 (with dollars), and the other adds $10', function () {
|
||||
$this->cart->add([
|
||||
[
|
||||
'id' => 456,
|
||||
'name' => 'Sample Item 1',
|
||||
'price' => 67.99,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
[
|
||||
'id' => 568,
|
||||
'name' => 'Sample Item 2',
|
||||
'price' => 69.25,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
]);
|
||||
|
||||
expect($this->cart->getSubTotal())->toEqual(137.24, 'Cart should have sub total of 137.24');
|
||||
expect($this->cart->getTotal())->toEqual(137.24, 'Cart should have total of 137.24');
|
||||
|
||||
// add conditions
|
||||
$couponCode = new CartCondition([
|
||||
'name' => 'Coupon code',
|
||||
'type' => 'discount',
|
||||
'target' => 'subtotal',
|
||||
'order' => '1',
|
||||
'value' => '-137.24',
|
||||
]);
|
||||
|
||||
$shipping = new CartCondition([
|
||||
'name' => 'Shipping',
|
||||
'type' => 'shipping',
|
||||
'target' => 'subtotal',
|
||||
'order' => '2',
|
||||
'value' => '10',
|
||||
]);
|
||||
|
||||
$this->cart->condition($couponCode);
|
||||
$this->cart->condition($shipping);
|
||||
|
||||
expect($this->cart->getSubTotal())->toEqual(10.00, 'Cart should have sub total of 10.00');
|
||||
expect($this->cart->getTotal())->toEqual(10.00, 'Cart should have a total of 10.00');
|
||||
});
|
||||
|
||||
test('can activate a dollar discount when a minimum amount is met', function () {
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Get $10 off when you spend $100',
|
||||
'type' => 'target',
|
||||
'target' => 'total',
|
||||
'value' => '-10',
|
||||
'minimum' => '100',
|
||||
]);
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(90, 'Cart should have total of 90');
|
||||
|
||||
$this->cart->clearItems();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 2,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(170, 'Cart should have total of 170');
|
||||
});
|
||||
|
||||
test('can activate a percentage discount when a minimum amount is met', function () {
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Get 10% off when you spend $100',
|
||||
'type' => 'target',
|
||||
'target' => 'total',
|
||||
'value' => '-10%',
|
||||
'minimum' => '100',
|
||||
]);
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(90, 'Cart should have total of 90');
|
||||
|
||||
$this->cart->clearItems();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 2,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(162, 'Cart should have total of 162');
|
||||
});
|
||||
|
||||
test('can remove a dollar value condition when a maximum is met', function () {
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Shipping',
|
||||
'type' => 'target',
|
||||
'target' => 'total',
|
||||
'value' => '18',
|
||||
'maximum' => '160',
|
||||
]);
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(108, 'Cart should have total of 108');
|
||||
|
||||
$this->cart->clear();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 2,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(180, 'Cart should have total of 180');
|
||||
});
|
||||
|
||||
test('can remove a percentage condition when a maximum is met', function () {
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Low Cart Tax',
|
||||
'type' => 'target',
|
||||
'target' => 'total',
|
||||
'value' => '10%',
|
||||
'maximum' => '140',
|
||||
]);
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(99, 'Cart should have total of 99');
|
||||
|
||||
$this->cart->clear();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 2,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(180, 'Cart should have total of 180');
|
||||
});
|
||||
|
||||
test('return cart conditions only when they are active', function () {
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Get $10 off when you spend $100',
|
||||
'type' => 'target',
|
||||
'target' => 'total',
|
||||
'value' => '-10',
|
||||
'minimum' => '100',
|
||||
]);
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
$this->cart->condition($condition);
|
||||
|
||||
expect($this->cart->getConditions(active: true))->toHaveCount(0, 'Cart should have 0 conditions');
|
||||
|
||||
$this->cart->clearItems();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
'name' => 'Apple iPhone 15',
|
||||
'price' => 90,
|
||||
'quantity' => 2,
|
||||
'attributes' => [],
|
||||
]);
|
||||
|
||||
expect($this->cart->getConditions(active: true))->toHaveCount(1, 'Cart should have 1 condition');
|
||||
});
|
||||
|
||||
test('can be removed by condition name', function () {
|
||||
$shipping = new CartCondition([
|
||||
'name' => 'Shipping',
|
||||
'type' => 'shipping',
|
||||
'target' => 'total',
|
||||
'value' => '12',
|
||||
]);
|
||||
|
||||
$tax = new CartCondition([
|
||||
'name' => 'Tax',
|
||||
'type' => 'tax',
|
||||
'target' => 'total',
|
||||
'value' => '2.50',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 456,
|
||||
'name' => 'Sample Item 1',
|
||||
'price' => 100,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
$this->cart->condition([$shipping, $tax]);
|
||||
|
||||
// let's prove first we have now two conditions in the cart
|
||||
expect($this->cart->getConditions()->count())->toEqual(2, 'Cart should have two conditions');
|
||||
|
||||
// now let's remove a specific condition by condition name
|
||||
$this->cart->removeCartCondition('Tax');
|
||||
|
||||
// cart should have now only 1 condition
|
||||
expect($this->cart->getConditions()->count())->toEqual(1, 'Cart should have one condition');
|
||||
expect($this->cart->getConditions()->first()->getName())->toEqual('Shipping');
|
||||
});
|
||||
});
|
||||
|
||||
describe('item level conditions', function () {
|
||||
test('can add an item with a condition', function () {
|
||||
test('can be added to an item', function () {
|
||||
$saleCondition = new CartCondition([
|
||||
'name' => '5% Discount',
|
||||
'type' => 'sale',
|
||||
@@ -818,6 +1278,41 @@
|
||||
expect($this->cart->getTotal())->toEqual(18, 'Cart should have total of 18');
|
||||
});
|
||||
|
||||
test('can be removed by name', function () {
|
||||
$itemCondition1 = new CartCondition([
|
||||
'name' => '5% Site Wide Sale',
|
||||
'type' => 'sale',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$itemCondition2 = new CartCondition([
|
||||
'name' => 'Mother\'s Day Gift Pack',
|
||||
'type' => 'promo',
|
||||
'value' => '-25',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 1,
|
||||
'name' => 'Body Scrub Kit',
|
||||
'price' => 100,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
'conditions' => [$itemCondition1, $itemCondition2],
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
// let's very first the item has 2 conditions in it
|
||||
expect($this->cart->get(1)['conditions'])->toHaveCount(2, 'The item should have two conditions');
|
||||
|
||||
// now let's remove a condition on that item using the condition name
|
||||
$this->cart->removeItemCondition(1, '5% Site Wide Sale');
|
||||
|
||||
// now we should have only 1 condition left on that item
|
||||
expect($this->cart->get(1)['conditions'])->toHaveCount(1, 'Item should have one condition left');
|
||||
expect($this->cart->get(1)['conditions'][1]->getName())->toEqual('Mother\'s Day Gift Pack');
|
||||
});
|
||||
|
||||
test('can add item with multiple negative item conditions', function () {
|
||||
$saleCondition = new CartCondition([
|
||||
'name' => '5% Sale',
|
||||
@@ -890,220 +1385,105 @@
|
||||
expect($this->cart->getTotal())->toEqual(411.77, 'Cart total with 1 item should be 411.77');
|
||||
});
|
||||
|
||||
test('add item condition', function () {
|
||||
test('can add item condition to an item that already has conditions', function () {
|
||||
$items = [
|
||||
[
|
||||
'id' => 456,
|
||||
'name' => 'Sample Item 1',
|
||||
'id' => 1,
|
||||
'name' => 'Children\'s Bookcase',
|
||||
'price' => 67.99,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
[
|
||||
'id' => 568,
|
||||
'name' => 'Sample Item 2',
|
||||
'price' => 69.25,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
[
|
||||
'id' => 856,
|
||||
'name' => 'Sample Item 3',
|
||||
'price' => 50.25,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
];
|
||||
|
||||
$this->cart->add($items);
|
||||
|
||||
$itemCondition2 = new CartCondition([
|
||||
'name' => 'Item Gift Pack 25.00',
|
||||
$discount = new CartCondition([
|
||||
'name' => '$25 Off',
|
||||
'type' => 'promo',
|
||||
'value' => '-25',
|
||||
]);
|
||||
$coupon101 = new CartCondition([
|
||||
'name' => 'COUPON 101',
|
||||
|
||||
$childrenDiscount = new CartCondition([
|
||||
'name' => '5% Off Childrens Items',
|
||||
'type' => 'coupon',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 456,
|
||||
'name' => 'Sample Item 1',
|
||||
'price' => 100,
|
||||
'id' => 2,
|
||||
'name' => 'Children\'s Pack of Books',
|
||||
'price' => 31.22,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
'conditions' => [$itemCondition2],
|
||||
'conditions' => [$discount],
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
// let's prove first we have 1 condition on this item
|
||||
expect($this->cart->get($item['id'])['conditions'])->toHaveCount(1, 'Item should have 1 condition');
|
||||
expect($this->cart->get(2)['conditions'])->toHaveCount(1, 'Item should have 1 condition');
|
||||
|
||||
// now let's insert a condition on an existing item on the cart
|
||||
$this->cart->addItemCondition($item['id'], $coupon101);
|
||||
$this->cart->addItemCondition(2, $childrenDiscount);
|
||||
|
||||
expect($this->cart->get($item['id'])['conditions'])->toHaveCount(2, 'Item should have 2 conditions');
|
||||
expect($this->cart->get(2)['conditions'])->toHaveCount(2, 'Item should have 2 conditions');
|
||||
});
|
||||
|
||||
test('add item condition restrict negative price', function () {
|
||||
$items = [
|
||||
[
|
||||
'id' => 456,
|
||||
'name' => 'Sample Item 1',
|
||||
'price' => 67.99,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
[
|
||||
'id' => 568,
|
||||
'name' => 'Sample Item 2',
|
||||
'price' => 69.25,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
[
|
||||
'id' => 856,
|
||||
'name' => 'Sample Item 3',
|
||||
'price' => 50.25,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
],
|
||||
test('will not take the price below 0', function () {
|
||||
$item = [
|
||||
'id' => 1,
|
||||
'name' => 'Picture Frame',
|
||||
'price' => 22.50,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
];
|
||||
|
||||
$this->cart->add($items);
|
||||
|
||||
$condition = new CartCondition([
|
||||
'name' => 'Substract amount but prevent negative value',
|
||||
'name' => '$25 Discount',
|
||||
'type' => 'promo',
|
||||
'value' => '-25',
|
||||
]);
|
||||
|
||||
$this->cart->add($item);
|
||||
$this->cart->addItemCondition(1, $condition);
|
||||
|
||||
// Since the product price is 20 and the condition reduces it by 25,
|
||||
// check that the item's price has been prevented from dropping below zero.
|
||||
expect($this->cart->get(1)->getPriceSumWithConditions())->toEqual(0.00, "The item's price should be prevented from going below zero.");
|
||||
});
|
||||
|
||||
test('can be removed by condition name', function () {
|
||||
$heavyItemSurcharge = new CartCondition([
|
||||
'name' => 'Heavy Item Surcharge',
|
||||
'type' => 'surcharge',
|
||||
'value' => '10',
|
||||
]);
|
||||
|
||||
$tax = new CartCondition([
|
||||
'name' => 'Tax',
|
||||
'type' => 'tax',
|
||||
'value' => '10%',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 789,
|
||||
'name' => 'Sample Item 1',
|
||||
'price' => 20,
|
||||
'id' => 12,
|
||||
'name' => 'Beer (1 box)',
|
||||
'price' => 410.60,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
'conditions' => [
|
||||
$condition,
|
||||
],
|
||||
'conditions' => [$heavyItemSurcharge, $tax],
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
// Since the product price is 20 and the condition reduces it by 25,
|
||||
// check that the item's price has been prevented from dropping below zero.
|
||||
expect($this->cart->get($item['id'])->getPriceSumWithConditions())->toEqual(0.00, "The item's price should be prevented from going below zero.");
|
||||
expect($this->cart->get(12)['conditions'])->toHaveCount(2, 'Item should have two conditions');
|
||||
|
||||
$this->cart->removeItemCondition(12, 'Tax');
|
||||
|
||||
expect($this->cart->get(12)['conditions'])->toHaveCount(1, 'Item should have one condition');
|
||||
});
|
||||
|
||||
// test('get cart condition by condition name', function () {
|
||||
// $itemCondition1 = new CartCondition([
|
||||
// 'name' => 'SALE 5%',
|
||||
// 'type' => 'sale',
|
||||
// 'target' => 'total',
|
||||
// 'value' => '-5%',
|
||||
// ]);
|
||||
// $itemCondition2 = new CartCondition([
|
||||
// 'name' => 'Item Gift Pack 25.00',
|
||||
// 'type' => 'promo',
|
||||
// 'target' => 'total',
|
||||
// 'value' => '-25',
|
||||
// ]);
|
||||
|
||||
// $item = [
|
||||
// 'id' => 456,
|
||||
// 'name' => 'Sample Item 1',
|
||||
// 'price' => 100,
|
||||
// 'quantity' => 1,
|
||||
// 'attributes' => [],
|
||||
// ];
|
||||
|
||||
// $this->cart->add($item);
|
||||
|
||||
// $this->cart->condition([$itemCondition1, $itemCondition2]);
|
||||
|
||||
// // get a condition applied on cart by condition name
|
||||
// $condition = $this->cart->getCondition($itemCondition1->getName());
|
||||
|
||||
// expect('SALE 5%')->toEqual($condition->getName());
|
||||
// expect('total')->toEqual($condition->getTarget());
|
||||
// expect('sale')->toEqual($condition->getType());
|
||||
// expect('-5%')->toEqual($condition->getValue());
|
||||
// });
|
||||
|
||||
// test('remove cart condition by condition name', function () {
|
||||
// $itemCondition1 = new CartCondition([
|
||||
// 'name' => 'SALE 5%',
|
||||
// 'type' => 'sale',
|
||||
// 'target' => 'total',
|
||||
// 'value' => '-5%',
|
||||
// ]);
|
||||
// $itemCondition2 = new CartCondition([
|
||||
// 'name' => 'Item Gift Pack 25.00',
|
||||
// 'type' => 'promo',
|
||||
// 'target' => 'total',
|
||||
// 'value' => '-25',
|
||||
// ]);
|
||||
|
||||
// $item = [
|
||||
// 'id' => 456,
|
||||
// 'name' => 'Sample Item 1',
|
||||
// 'price' => 100,
|
||||
// 'quantity' => 1,
|
||||
// 'attributes' => [],
|
||||
// ];
|
||||
|
||||
// $this->cart->add($item);
|
||||
|
||||
// $this->cart->condition([$itemCondition1, $itemCondition2]);
|
||||
|
||||
// // let's prove first we have now two conditions in the cart
|
||||
// expect($this->cart->getConditions()->count())->toEqual(2, 'Cart should have two conditions');
|
||||
|
||||
// // now let's remove a specific condition by condition name
|
||||
// $this->cart->removeCartCondition('SALE 5%');
|
||||
|
||||
// // cart should have now only 1 condition
|
||||
// expect($this->cart->getConditions()->count())->toEqual(1, 'Cart should have one condition');
|
||||
// expect($this->cart->getConditions()->first()->getName())->toEqual('Item Gift Pack 25.00');
|
||||
// });
|
||||
|
||||
// test('remove item condition by condition name', function () {
|
||||
// $itemCondition1 = new CartCondition([
|
||||
// 'name' => 'SALE 5%',
|
||||
// 'type' => 'sale',
|
||||
// 'value' => '-5%',
|
||||
// ]);
|
||||
// $itemCondition2 = new CartCondition([
|
||||
// 'name' => 'Item Gift Pack 25.00',
|
||||
// 'type' => 'promo',
|
||||
// 'value' => '-25',
|
||||
// ]);
|
||||
|
||||
// $item = [
|
||||
// 'id' => 456,
|
||||
// 'name' => 'Sample Item 1',
|
||||
// 'price' => 100,
|
||||
// 'quantity' => 1,
|
||||
// 'attributes' => [],
|
||||
// 'conditions' => [$itemCondition1, $itemCondition2],
|
||||
// ];
|
||||
|
||||
// $this->cart->add($item);
|
||||
|
||||
// // let's very first the item has 2 conditions in it
|
||||
// expect($this->cart->get(456)['conditions'])->toHaveCount(2, 'Item should have two conditions');
|
||||
|
||||
// // now let's remove a condition on that item using the condition name
|
||||
// $this->cart->removeItemCondition(456, 'SALE 5%');
|
||||
|
||||
// // now we should have only 1 condition left on that item
|
||||
// expect($this->cart->get(456)['conditions'])->toHaveCount(1, 'Item should have one condition left');
|
||||
// });
|
||||
|
||||
// test('remove item condition by condition name scenario two', function () {
|
||||
// // NOTE: in this scenario, we will add the conditions not in array format
|
||||
// $itemCondition = new CartCondition([
|
||||
@@ -1473,5 +1853,4 @@
|
||||
// expect($this->cart->getConditions()->first()->getName())->toEqual('Item Gift Pack 20');
|
||||
// expect($this->cart->getConditions()->last()->getName())->toEqual('TAX');
|
||||
// });
|
||||
|
||||
});
|
||||
|
||||
+43
-17
@@ -49,6 +49,19 @@
|
||||
expect($this->cart->getTotal())->toEqual(0, 'Total should be 0');
|
||||
});
|
||||
|
||||
test('can add an item an array with no price', function () {
|
||||
$this->cart->add([
|
||||
'id' => 455,
|
||||
'name' => 'Sample Item',
|
||||
'quantity' => 2,
|
||||
]);
|
||||
|
||||
expect($this->cart->isEmpty())->toBeFalse('Cart should not be empty');
|
||||
expect($this->cart->getContent()->count())->toEqual(1, 'Cart content should be 1');
|
||||
expect($this->cart->getContent()->first()['id'])->toEqual(455, 'Item added has ID of 455 so first content ID should be 455');
|
||||
expect($this->cart->getTotal())->toEqual(0, 'Total should be 0');
|
||||
});
|
||||
|
||||
test('can add an item without attributes', function () {
|
||||
$item = [
|
||||
'id' => 1,
|
||||
@@ -283,6 +296,24 @@
|
||||
|
||||
expect($item['quantity'])->toEqual(9.9, 'Item quantity should be 9.9');
|
||||
});
|
||||
|
||||
test('should throw an exception when no quantity is provided', function () {
|
||||
$this->expectException('Wearepixel\Cart\Exceptions\InvalidItemException');
|
||||
$this->expectExceptionMessage('The quantity must be at least 0.1.');
|
||||
$this->cart->add(455, 'Sample Item', 100.99, 0, []);
|
||||
});
|
||||
|
||||
test('should throw an exception when no id is provided', function () {
|
||||
$this->expectException('Wearepixel\Cart\Exceptions\InvalidItemException');
|
||||
$this->expectExceptionMessage('The id field is required.');
|
||||
$this->cart->add('', 'Sample Item', 100.99, 2, []);
|
||||
});
|
||||
|
||||
test('should throw an exception when no name is provided', function () {
|
||||
$this->expectException('Wearepixel\Cart\Exceptions\InvalidItemException');
|
||||
$this->expectExceptionMessage('The name field is required.');
|
||||
$this->cart->add(523, '', 100.99, 2, []);
|
||||
});
|
||||
});
|
||||
|
||||
test('cart items attributes', function () {
|
||||
@@ -477,8 +508,6 @@
|
||||
});
|
||||
|
||||
test('sub total when item quantity is updated by reduced', function () {
|
||||
// $this->cart->setConfig(['format_numbers' => true, 'decimals' => 2, 'dec_point' => '.', 'thousands_sep' => ',']);
|
||||
|
||||
$items = [
|
||||
[
|
||||
'id' => 456,
|
||||
@@ -544,21 +573,6 @@
|
||||
expect($item['quantity'])->toEqual(3, 'Item quantity of with item ID of 456 should now be reduced to 2');
|
||||
});
|
||||
|
||||
test('should throw exception when provided invalid values scenario one', function () {
|
||||
$this->expectException('Wearepixel\Cart\Exceptions\InvalidItemException');
|
||||
$this->cart->add(455, 'Sample Item', 100.99, 0, []);
|
||||
});
|
||||
|
||||
test('should throw exception when provided invalid values scenario two', function () {
|
||||
$this->expectException('Wearepixel\Cart\Exceptions\InvalidItemException');
|
||||
$this->cart->add('', 'Sample Item', 100.99, 2, []);
|
||||
});
|
||||
|
||||
test('should throw exception when provided invalid values scenario three', function () {
|
||||
$this->expectException('Wearepixel\Cart\Exceptions\InvalidItemException');
|
||||
$this->cart->add(523, '', 100.99, 2, []);
|
||||
});
|
||||
|
||||
test('clearing cart', function () {
|
||||
$items = [
|
||||
[
|
||||
@@ -675,3 +689,15 @@
|
||||
expect($this->cart->getTotalQuantity())->toBeInt('Return type should be INT');
|
||||
expect($this->cart->getTotalQuantity())->toEqual(12, 'Cart\'s quantity should be 4.');
|
||||
});
|
||||
|
||||
test('can add to cart and then update the session key', function () {
|
||||
$this->cart->add(1, 'Sample Item', 100.99, 2, []);
|
||||
|
||||
expect($this->cart->getContent()->count())->toEqual(1, 'Cart content should be 1');
|
||||
expect($this->cart->getContent()->first()['id'])->toEqual(1, 'Item added has ID of 1 so first content ID should be 1');
|
||||
|
||||
$this->cart->setSessionKey('new_session_key');
|
||||
|
||||
expect($this->cart->getSessionKey())->toEqual('new_session_key', 'Session key should be updated to new_session_key');
|
||||
expect($this->cart->getContent()->count())->toEqual(1, 'Cart content should still be 1');
|
||||
});
|
||||
|
||||
@@ -9,9 +9,9 @@
|
||||
Mockery::close();
|
||||
});
|
||||
|
||||
test('event cart created', function () {
|
||||
test('event cart Created', function () {
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Created', Mockery::type('array'), true);
|
||||
|
||||
$cart = new Cart(
|
||||
new SessionMock,
|
||||
@@ -25,10 +25,10 @@
|
||||
});
|
||||
|
||||
test('event cart adding', function () {
|
||||
$events = Mockery::mock('Illuminate\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.added', Mockery::type('array'), true);
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Added', Mockery::type('array'), true);
|
||||
|
||||
$cart = new Cart(
|
||||
new SessionMock,
|
||||
@@ -44,10 +44,10 @@
|
||||
});
|
||||
|
||||
test('event cart adding multiple times', function () {
|
||||
$events = Mockery::mock('Illuminate\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(2)->with('cart.adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(2)->with('cart.added', Mockery::type('array'), true);
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(2)->with('LaravelCart.Adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(2)->with('LaravelCart.Added', Mockery::type('array'), true);
|
||||
|
||||
$cart = new Cart(
|
||||
new SessionMock,
|
||||
@@ -64,10 +64,10 @@
|
||||
});
|
||||
|
||||
test('event cart adding multiple times scenario two', function () {
|
||||
$events = Mockery::mock('Illuminate\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('cart.adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('cart.added', Mockery::type('array'), true);
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('LaravelCart.Adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('LaravelCart.Added', Mockery::type('array'), true);
|
||||
|
||||
$items = [
|
||||
[
|
||||
@@ -107,12 +107,12 @@
|
||||
});
|
||||
|
||||
test('event cart remove item', function () {
|
||||
$events = Mockery::mock('Illuminate\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('cart.adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('cart.added', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(1)->with('cart.removing', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(1)->with('cart.removed', Mockery::type('array'), true);
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('LaravelCart.Adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('LaravelCart.Added', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(1)->with('LaravelCart.Removing', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(1)->with('LaravelCart.Removed', Mockery::type('array'), true);
|
||||
|
||||
$items = [
|
||||
[
|
||||
@@ -154,12 +154,12 @@
|
||||
});
|
||||
|
||||
test('event cart clear', function () {
|
||||
$events = Mockery::mock('Illuminate\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('cart.adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('cart.added', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.clearing', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.cleared', Mockery::type('array'), true);
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('LaravelCart.Adding', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->times(3)->with('LaravelCart.Added', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Clearing', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('LaravelCart.Cleared', Mockery::type('array'), true);
|
||||
|
||||
$items = [
|
||||
[
|
||||
|
||||
@@ -0,0 +1,126 @@
|
||||
<?php
|
||||
|
||||
use Wearepixel\Cart\Cart;
|
||||
use Wearepixel\Cart\CartCondition;
|
||||
use Wearepixel\Cart\Tests\Helpers\MockCartModel;
|
||||
|
||||
beforeEach(function () {
|
||||
$events = Mockery::mock('Illuminate\Contracts\Events\Dispatcher');
|
||||
$events->shouldReceive('dispatch');
|
||||
|
||||
$storage = new MockCartModel;
|
||||
|
||||
$this->cart = new Cart(
|
||||
$storage,
|
||||
$events,
|
||||
'cart',
|
||||
'SAMPLESESSIONKEY',
|
||||
require (__DIR__ . '/../Helpers/ConfigDatabaseMock.php')
|
||||
);
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
Mockery::close();
|
||||
});
|
||||
|
||||
describe('database cart', function () {
|
||||
test('can add an item', function () {
|
||||
$this->cart->add(1, 'Sample Item', 100.99, 2, []);
|
||||
|
||||
expect($this->cart->isEmpty())->toBeFalse('Cart should not be empty');
|
||||
expect($this->cart->getContent()->count())->toEqual(1, 'Cart content should be 1');
|
||||
expect($this->cart->getContent()->first()['id'])->toEqual(1, 'Item added has ID of 1 so first content ID should be 1');
|
||||
expect($this->cart->getContent()->first()['price'])->toEqual(100.99, 'Item added has price of 100.99 so first content price should be 100.99');
|
||||
|
||||
expect(MockCartModel::all()->count())->toEqual(1, 'The carts database table should have 1 row');
|
||||
});
|
||||
|
||||
test('can add and remove an item', function () {
|
||||
$this->cart->add(1, 'Sample Item', 100.99, 2, []);
|
||||
|
||||
expect($this->cart->isEmpty())->toBeFalse('Cart should not be empty');
|
||||
expect($this->cart->getContent()->count())->toEqual(1, 'Cart content should be 1');
|
||||
expect($this->cart->getContent()->first()['id'])->toEqual(1, 'Item added has ID of 1 so first content ID should be 1');
|
||||
expect($this->cart->getContent()->first()['price'])->toEqual(100.99, 'Item added has price of 100.99 so first content price should be 100.99');
|
||||
|
||||
expect(MockCartModel::all()->count())->toEqual(1, 'The carts database table should have 1 row');
|
||||
|
||||
$this->cart->remove(1);
|
||||
|
||||
$cartModel = MockCartModel::first();
|
||||
|
||||
expect($this->cart->isEmpty())->toBeTrue('Cart should be empty');
|
||||
expect($this->cart->getContent()->count())->toEqual(0, 'Cart content should be 0');
|
||||
expect($cartModel->items)->toEqual([], 'The carts database table should have 0 row');
|
||||
});
|
||||
|
||||
test('can add an item with an item level condition', function () {
|
||||
$saleCondition = new CartCondition([
|
||||
'name' => '5% Discount',
|
||||
'type' => 'sale',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 1,
|
||||
'name' => 'Chicken Curry',
|
||||
'price' => 18.95,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
'conditions' => $saleCondition,
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
expect($this->cart->get(1)->getPriceSum())->toEqual(18.95);
|
||||
expect($this->cart->get(1)->getPriceSumWithConditions())->toEqual(18);
|
||||
expect($this->cart->getSubTotal())->toEqual(18, 'Cart should have subtotal of 18');
|
||||
expect($this->cart->getTotal())->toEqual(18, 'Cart should have total of 18');
|
||||
});
|
||||
|
||||
test('can add an item with multiple item level conditions', function () {
|
||||
$saleCondition = new CartCondition([
|
||||
'name' => '5% Discount',
|
||||
'type' => 'sale',
|
||||
'value' => '-5%',
|
||||
]);
|
||||
|
||||
$gstCondition = new CartCondition([
|
||||
'name' => 'GST',
|
||||
'type' => 'gst',
|
||||
'value' => '2.5%',
|
||||
]);
|
||||
|
||||
$item = [
|
||||
'id' => 1,
|
||||
'name' => 'Chicken Curry',
|
||||
'price' => 18.95,
|
||||
'quantity' => 1,
|
||||
'attributes' => [],
|
||||
'conditions' => [$saleCondition, $gstCondition],
|
||||
];
|
||||
|
||||
$this->cart->add($item);
|
||||
|
||||
expect($this->cart->get(1)->getPriceSum())->toEqual(18.95);
|
||||
expect($this->cart->get(1)->getPriceSumWithConditions())->toEqual(18.45);
|
||||
expect($this->cart->getSubTotal())->toEqual(18.45, 'Cart should have subtotal of 18.45');
|
||||
expect($this->cart->getTotal())->toEqual(18.45, 'Cart should have total of 18.45');
|
||||
});
|
||||
|
||||
test('can clear a simple cart', function () {
|
||||
$this->cart->add(1, 'Sample Item', 100.99, 2, []);
|
||||
|
||||
expect($this->cart->isEmpty())->toBeFalse('Cart should not be empty');
|
||||
expect($this->cart->getContent()->count())->toEqual(1, 'Cart content should be 1');
|
||||
expect($this->cart->getContent()->first()['id'])->toEqual(1, 'Item added has ID of 1 so first content ID should be 1');
|
||||
expect($this->cart->getContent()->first()['price'])->toEqual(100.99, 'Item added has price of 100.99 so first content price should be 100.99');
|
||||
expect(MockCartModel::all()->count())->toEqual(1, 'The carts database table should have 1 row');
|
||||
|
||||
$this->cart->clear();
|
||||
|
||||
expect($this->cart->isEmpty())->toBeTrue('Cart should be empty');
|
||||
expect($this->cart->getContent()->count())->toEqual(0, 'Cart content should be 0');
|
||||
expect(MockCartModel::all()->count())->toEqual(0, 'The carts database table should have 0 rows');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,14 @@
|
||||
<?php
|
||||
|
||||
require __DIR__ . '/../vendor/autoload.php';
|
||||
|
||||
// Suppress PHP 8.4 deprecation notices that originate from vendor code.
|
||||
// These are typically from third-party packages (e.g. Mockery) that have not
|
||||
// yet updated implicit-nullable parameter signatures and are not actionable here.
|
||||
set_error_handler(static function (int $errno, string $errstr, string $errfile): bool {
|
||||
if ($errno === E_DEPRECATED && str_contains($errfile, DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}, E_DEPRECATED);
|
||||
Reference in New Issue
Block a user