mirror of
https://github.com/wearepixel/laravel-cart.git
synced 2026-11-14 22:01:48 +00:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Joel Male
|
489b2723d5 | ||
|
Joel Male
|
d3f673d52f |
+5
-21
@@ -1,33 +1,17 @@
|
||||
version: 2
|
||||
|
||||
updates:
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
target-branch: "master"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "monday"
|
||||
open-pull-requests-limit: 10
|
||||
groups:
|
||||
actions:
|
||||
patterns: ["*"]
|
||||
commit-message:
|
||||
prefix: "chore"
|
||||
include: "scope"
|
||||
labels:
|
||||
- "dependencies"
|
||||
|
||||
- "deps"
|
||||
- package-ecosystem: "composer"
|
||||
directory: "/"
|
||||
target-branch: "master"
|
||||
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"
|
||||
- "deps"
|
||||
|
||||
@@ -13,7 +13,7 @@ jobs:
|
||||
|
||||
- name: Dependabot metadata
|
||||
id: metadata
|
||||
uses: dependabot/fetch-metadata@25dd0e34f4fe68f24cc83900b1fe3fe149efef98 # v3.1.0
|
||||
uses: dependabot/fetch-metadata@v2.2.0
|
||||
with:
|
||||
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||
|
||||
|
||||
@@ -9,19 +9,19 @@ on:
|
||||
jobs:
|
||||
tests:
|
||||
name: Tests
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-20.04
|
||||
strategy:
|
||||
fail-fast: true
|
||||
matrix:
|
||||
php: ["8.3", "8.4", "8.5"]
|
||||
php: ['8.1', '8.2', '8.3']
|
||||
stability: [prefer-stable]
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@7c071dfe9dc99bdf297fa79cb49ea005b9fcadbc # v2
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php }}
|
||||
extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd, redis, memcached
|
||||
@@ -29,11 +29,12 @@ jobs:
|
||||
coverage: none
|
||||
|
||||
- name: Install dependencies
|
||||
uses: nick-fields/retry@ad984534de44a9489a53aefd81eb77f87c70dc60 # v4.0.0
|
||||
uses: nick-fields/retry@v3
|
||||
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
|
||||
run: vendor/bin/pest
|
||||
+1
-2
@@ -3,5 +3,4 @@
|
||||
.idea
|
||||
.phpunit.result.cache
|
||||
READMETODO.md
|
||||
build
|
||||
docs/superpowers/
|
||||
build
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Joel Male <joel@joelmale.com>
|
||||
Copyright (c) Pixel Digital Pty Ltd <hello@wearepixel.com.au>
|
||||
|
||||
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,74 +1,41 @@
|
||||
<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: 10, 11, 12, and 13.
|
||||
Supported Laravel Versions: 9, 10, 11
|
||||
|
||||
For Laravel 9.0 and below, please use version [1.0](https://github.com/wearepixel/laravel-cart/releases/tag/1.0.12)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [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)
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
### 🔥 Installing
|
||||
|
||||
Install the package through [Composer](http://getcomposer.org/).
|
||||
|
||||
`composer require wearepixel/laravel-cart`
|
||||
|
||||
## 🧑🍳 Demo
|
||||
## Quick 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
|
||||
);
|
||||
\Cart::add(1, 'Product 1', 19.99, 2, ['size' => 'large']);
|
||||
|
||||
// get the entire cart
|
||||
// Get the cart contents
|
||||
$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
|
||||
);
|
||||
// Update item quantity by its id
|
||||
\Cart::update(1, ['quantity' => 3]);
|
||||
|
||||
// remove the item by its id
|
||||
// Remove an item from the cart by its id
|
||||
\Cart::remove(1);
|
||||
|
||||
// get the total of the cart
|
||||
$total = Cart::getTotal();
|
||||
// Get cart total
|
||||
\$total = Cart::getTotal();
|
||||
|
||||
// clear it all when you've finished (like when you've stored the order)
|
||||
// Clear the entire cart
|
||||
\Cart::clear();
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
## Installing
|
||||
|
||||
### ⚙️ Configuration
|
||||
Install the package through [Composer](http://getcomposer.org/).
|
||||
|
||||
`composer require "wearepixel/laravel-cart"`
|
||||
|
||||
## Configuration
|
||||
|
||||
You can publish the configuration file to customize various options.
|
||||
|
||||
@@ -76,7 +43,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().
|
||||
|
||||
@@ -89,7 +56,7 @@ #### Formatting Numbers
|
||||
'round_mode' => env('LARAVEL_CART_ROUND_MODE', 'down'),
|
||||
```
|
||||
|
||||
#### Decimals
|
||||
### Decimals
|
||||
|
||||
You can customize the number of decimals in the configuration file.
|
||||
|
||||
@@ -99,7 +66,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.
|
||||
|
||||
@@ -109,22 +76,40 @@ #### Round Mode
|
||||
'round_mode' => env('LARAVEL_CART_ROUND_MODE', 'down'),
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
## Usage
|
||||
|
||||
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.
|
||||
- [Basic Usage](#basic-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)
|
||||
|
||||
This also serves as a cart unique identifier which you can use to bind a cart to a specific user if you want to.
|
||||
## Usage
|
||||
|
||||
Make sure to call `\Cart::setSessionKey($sessionKey)` before calling any other cart methods.
|
||||
The cart has a default sessionKey that holds the cart data and stores it in the session.
|
||||
|
||||
This
|
||||
also serves as a cart unique identifier which you can use to bind a cart to a specific user if you want to.
|
||||
|
||||
Make sure to call `\Cart::session($sessionKey)` before calling any other cart methods.
|
||||
|
||||
Usually this is not required.
|
||||
|
||||
```php
|
||||
// Binds the cart to a unique id (user id, session id, etc.)
|
||||
\Cart::setSessionKey(User::first()->id);
|
||||
\Cart::session(User::first()->id);
|
||||
|
||||
// If you don't want to bind the cart on a project level, you can add it to each call
|
||||
\Cart::session(User::first()->id)->add(1, 'Product 1', 19.99, 2, ['size' => 'large']);
|
||||
```
|
||||
|
||||
#### Adding to the cart: **Cart::add()**
|
||||
### Adding to the cart: **Cart::add()**
|
||||
|
||||
There are a few ways to add items to the cart.
|
||||
|
||||
@@ -169,8 +154,8 @@ #### Adding to the cart: **Cart::add()**
|
||||
[], // attributes
|
||||
[
|
||||
[
|
||||
'name' => '10% Off',
|
||||
'type' => 'discount',
|
||||
'name' => '10% Off',
|
||||
'type' => 'discount',
|
||||
'value' => '-10%'
|
||||
]
|
||||
] // conditions
|
||||
@@ -195,12 +180,12 @@ #### 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(
|
||||
456, # product id
|
||||
[
|
||||
[
|
||||
'name' => 'New Item Name', // new item name
|
||||
'price' => 98.67, // new item price as a float or string
|
||||
]
|
||||
@@ -216,7 +201,7 @@ #### Updating an item on a cart: **Cart::update()**
|
||||
|
||||
// reducing it...
|
||||
Cart::update(
|
||||
456,
|
||||
456,
|
||||
[
|
||||
'quantity' => -1, // so if from 4 to 3
|
||||
]
|
||||
@@ -234,14 +219,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
|
||||
@@ -251,7 +236,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
|
||||
@@ -271,13 +256,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();
|
||||
@@ -289,29 +274,19 @@ #### 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()**
|
||||
|
||||
This clears all items and conditions from the cart.
|
||||
### Clearing the Cart: **Cart::clear()**
|
||||
|
||||
```php
|
||||
Cart::clear();
|
||||
```
|
||||
|
||||
#### Clearing the cart items only: **Cart::clearItems()**
|
||||
|
||||
This clears all items, but keeps the conditions (useful for when you want to keep the conditions but remove the items)
|
||||
|
||||
```php
|
||||
Cart::clearItems();
|
||||
```
|
||||
|
||||
### Conditions
|
||||
## Conditions
|
||||
|
||||
Conditions are very useful for adding things like discounts, taxes, shipping, etc.
|
||||
|
||||
@@ -323,9 +298,9 @@ ### Conditions
|
||||
|
||||
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
|
||||
@@ -376,7 +351,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:
|
||||
@@ -395,7 +370,7 @@ ##### Getting conditions on the cart: **Cart::getConditions()**
|
||||
}
|
||||
```
|
||||
|
||||
##### Getting conditions on the cart as an array: **Cart::getConditions(array: true)**
|
||||
#### 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.
|
||||
|
||||
@@ -414,7 +389,7 @@ ##### Getting conditions on the cart as an array: **Cart::getConditions(array: t
|
||||
}
|
||||
```
|
||||
|
||||
##### Getting conditions by name: **Cart::getCondition($conditionName)**
|
||||
#### Getting conditions by name: **Cart::getCondition($conditionName)**
|
||||
|
||||
```php
|
||||
$condition = Cart::getCondition('GST');
|
||||
@@ -428,7 +403,7 @@ ##### Getting conditions by name: **Cart::getCondition($conditionName)**
|
||||
$condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
|
||||
```
|
||||
|
||||
##### Getting active conditions on the cart: **Cart::getConditions(active: true)**
|
||||
#### Getting active conditions on the cart: **Cart::getConditions(active: true)**
|
||||
|
||||
You can get only active conditions by passsing `active: true` to the `getConditions()` method.
|
||||
|
||||
@@ -464,14 +439,14 @@ ##### Getting active conditions on the cart: **Cart::getConditions(active: true)
|
||||
// will return no conditions if the subtotal is $210
|
||||
```
|
||||
|
||||
##### Calculating condition value
|
||||
### 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();
|
||||
@@ -479,7 +454,7 @@ ##### Using the `getCalculatedValue` method on the condition instance
|
||||
$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.
|
||||
|
||||
@@ -512,7 +487,7 @@ ##### 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
|
||||
```
|
||||
|
||||
##### Adding conditions that activate once a minimum value is met
|
||||
### Adding conditions that activate once a minimum value is met
|
||||
|
||||
You can add a `minimum` amount required for a condition to activate.
|
||||
|
||||
@@ -531,7 +506,7 @@ ##### Adding conditions that activate once a minimum value is met
|
||||
Cart::condition($tenPercentOff)
|
||||
```
|
||||
|
||||
##### Adding conditions that only activate up to a maximum value
|
||||
### Adding conditions that only activate up to a maximum value
|
||||
|
||||
You can add a `maximum` amount required for a condition to activate.
|
||||
|
||||
@@ -550,7 +525,7 @@ ##### Adding conditions that only activate up to a maximum value
|
||||
Cart::condition($shipping)
|
||||
```
|
||||
|
||||
#### Conditions on items
|
||||
### Condition on items
|
||||
|
||||
Item conditions are useful if you have discounts to be applied specifically on an item and not on the whole cart value.
|
||||
|
||||
@@ -611,7 +586,7 @@ #### Conditions on items
|
||||
$cartSubTotal = Cart::getSubTotal();
|
||||
```
|
||||
|
||||
##### Add a condition to an 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.
|
||||
|
||||
@@ -625,7 +600,7 @@ ##### Add a condition to an existing item on the cart: **Cart::addItemCondition(
|
||||
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.
|
||||
|
||||
@@ -639,25 +614,25 @@ #### Clearing Cart Conditions: **Cart::clearCartConditions()**
|
||||
Cart::clearAllConditions()
|
||||
```
|
||||
|
||||
##### Remove a specific cart condtion: **Cart::removeCartCondition($conditionName)**
|
||||
### 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.
|
||||
|
||||
@@ -665,13 +640,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.
|
||||
|
||||
@@ -693,153 +668,8 @@ ### Cart Items
|
||||
$item->getPriceSumWithConditions();
|
||||
```
|
||||
|
||||
### Storage Options
|
||||
## Credits
|
||||
|
||||
By default the cart is stored in the session, but there are times you may want to store the cart in the database.
|
||||
Huge credits to the original maintainer of the package, located at [darryldecode/laravelshoppingcart](https://github.com/darryldecode/laravelshoppingcart)
|
||||
|
||||
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.
|
||||
We have forked this package to update it to Laravel 11 and to add some features and support for newer PHP versions.
|
||||
-11
@@ -1,11 +0,0 @@
|
||||
# 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.
|
||||
+10
-17
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "wearepixel/laravel-cart",
|
||||
"version": "2.1.3",
|
||||
"version": "1.0.8",
|
||||
"description": "A cart implementation for Laravel",
|
||||
"keywords": [
|
||||
"laravel",
|
||||
@@ -15,33 +15,26 @@
|
||||
},
|
||||
{
|
||||
"name": "Joel Male",
|
||||
"email": "joel@joelmale.com"
|
||||
"email": "joel@wearepixel.com.au"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"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"
|
||||
"php": ">=8.1",
|
||||
"illuminate/support": "^9.0|^10.0|^11.0",
|
||||
"illuminate/validation": "^9.0|^10.0|^11.0",
|
||||
"illuminate/translation": "^9.0|^10.0|^11.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"mockery/mockery": "^2.0",
|
||||
"laravel/pint": "^1.21",
|
||||
"pestphp/pest": "^4.7",
|
||||
"larapack/dd": "dev-master"
|
||||
"mockery/mockery": "^1.4.2",
|
||||
"laravel/pint": "^1.17",
|
||||
"pestphp/pest": "2.35.1",
|
||||
"larapack/dd": "1.1"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Wearepixel\\Cart\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Tests\\": "tests/"
|
||||
}
|
||||
},
|
||||
"minimum-stability": "dev",
|
||||
"extra": {
|
||||
"laravel": {
|
||||
|
||||
Generated
+1603
-4033
File diff suppressed because it is too large
Load Diff
+8
-11
@@ -14,18 +14,15 @@
|
||||
|
||||
/*
|
||||
* ---------------------------------------------------------------
|
||||
* Storage
|
||||
* Persistence
|
||||
* ---------------------------------------------------------------
|
||||
*/
|
||||
'driver' => 'session',
|
||||
'storage' => null,
|
||||
|
||||
'storage' => [
|
||||
'session',
|
||||
'database' => [
|
||||
'model' => '',
|
||||
'id' => '',
|
||||
'items' => '',
|
||||
'conditions' => '',
|
||||
],
|
||||
],
|
||||
/*
|
||||
* ---------------------------------------------------------------
|
||||
* Events
|
||||
* ---------------------------------------------------------------
|
||||
*/
|
||||
'events' => null,
|
||||
];
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 41 KiB |
+7
-6
@@ -1,16 +1,17 @@
|
||||
<?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">
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd"
|
||||
>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">./src</directory>
|
||||
</include>
|
||||
</source>
|
||||
<testsuites>
|
||||
<testsuites>
|
||||
<testsuite name="Laravel Cart Test Suite">
|
||||
<directory>tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<php>
|
||||
<env name="DB_CONNECTION" value="testing"/>
|
||||
</php>
|
||||
</phpunit>
|
||||
|
||||
+83
-112
@@ -15,6 +15,10 @@ class Cart
|
||||
|
||||
protected $instanceName;
|
||||
|
||||
protected $sessionKey;
|
||||
protected $sessionKeyCartItems;
|
||||
protected $sessionKeyCartConditions;
|
||||
|
||||
protected $config;
|
||||
|
||||
protected $currentItemId;
|
||||
@@ -22,48 +26,39 @@ class Cart
|
||||
protected $decimals;
|
||||
protected $decPoint;
|
||||
|
||||
public function __construct($sessionStorage, $events, $instanceName, $sessionKey, $config)
|
||||
public function __construct($session, $events, $instanceName, $session_key, $config)
|
||||
{
|
||||
$this->validateConfig($config);
|
||||
|
||||
$this->events = $events;
|
||||
$this->session = new CartSession($sessionStorage, $sessionKey, $config);
|
||||
$this->session = $session;
|
||||
$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');
|
||||
}
|
||||
|
||||
private function validateConfig($config)
|
||||
/**
|
||||
* sets the session key
|
||||
*
|
||||
* @param string $sessionKey the session key or identifier
|
||||
* @return $this|bool
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function session($sessionKey)
|
||||
{
|
||||
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.');
|
||||
}
|
||||
if (! $sessionKey) {
|
||||
throw new \Exception('Session key is required.');
|
||||
}
|
||||
}
|
||||
|
||||
public function getSessionKey(): string
|
||||
{
|
||||
return $this->session->getSessionKey();
|
||||
}
|
||||
$this->sessionKey = $sessionKey;
|
||||
$this->sessionKeyCartItems = $this->sessionKey . '_cart_items';
|
||||
$this->sessionKeyCartConditions = $this->sessionKey . '_cart_conditions';
|
||||
|
||||
public function setSessionKey(string $sessionKey): void
|
||||
{
|
||||
$this->session->setSessionKey($sessionKey);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -165,37 +160,15 @@ public function add(
|
||||
|
||||
$this->currentItemId = $id;
|
||||
|
||||
// clean up any incomplete items
|
||||
$this->removeInvalidItems();
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove any incomplete items
|
||||
*/
|
||||
public function removeInvalidItems(): bool
|
||||
{
|
||||
$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) {
|
||||
if ($this->fireEvent('updating', $data) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -228,7 +201,7 @@ public function update(int|string $id, array $data): bool
|
||||
|
||||
$this->save($cart);
|
||||
|
||||
$this->fireEvent('Updated', 'item', $item);
|
||||
$this->fireEvent('updated', $item);
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -287,7 +260,7 @@ public function remove($id)
|
||||
{
|
||||
$cart = $this->getContent();
|
||||
|
||||
if ($this->fireEvent('Removing', 'item', $id) === false) {
|
||||
if ($this->fireEvent('removing', $id) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -295,33 +268,28 @@ public function remove($id)
|
||||
|
||||
$this->save($cart);
|
||||
|
||||
$this->fireEvent('Removed', 'item', $id);
|
||||
$this->fireEvent('removed', $id);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* clear cart
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function clear()
|
||||
{
|
||||
if ($this->fireEvent('Clearing') === false) {
|
||||
if ($this->fireEvent('clearing') === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->session->clear();
|
||||
$this->session->put(
|
||||
$this->sessionKeyCartItems,
|
||||
[]
|
||||
);
|
||||
|
||||
$this->fireEvent('Cleared');
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public function clearItems()
|
||||
{
|
||||
if ($this->fireEvent('Clearing') === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->session->clearItems();
|
||||
|
||||
$this->fireEvent('Cleared');
|
||||
$this->fireEvent('cleared');
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -358,9 +326,7 @@ public function condition(array|CartCondition $condition): self
|
||||
|
||||
$conditions->put($condition->getName(), $condition);
|
||||
|
||||
$conditions = $conditions->reject(function ($condition) {
|
||||
return empty($condition);
|
||||
})->sortBy(function ($condition, $key) {
|
||||
$conditions = $conditions->sortBy(function ($condition, $key) {
|
||||
return $condition->getOrder();
|
||||
});
|
||||
|
||||
@@ -376,14 +342,9 @@ public function condition(array|CartCondition $condition): self
|
||||
*/
|
||||
public function getConditions(bool $array = false, bool $active = false): CartConditionCollection|array
|
||||
{
|
||||
$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);
|
||||
});
|
||||
$conditions = new CartConditionCollection(
|
||||
$this->session->get($this->sessionKeyCartConditions)
|
||||
);
|
||||
|
||||
if ($active) {
|
||||
return $conditions->filter(function (CartCondition $condition) {
|
||||
@@ -445,6 +406,9 @@ public function removeCartCondition($conditionName)
|
||||
|
||||
$conditions->pull($conditionName);
|
||||
|
||||
// reset indexes
|
||||
$conditions = $conditions->values();
|
||||
|
||||
$this->saveConditions($conditions);
|
||||
}
|
||||
|
||||
@@ -497,6 +461,9 @@ public function removeItemCondition($itemId, $conditionName)
|
||||
}
|
||||
}
|
||||
|
||||
// reset indexes
|
||||
$item['conditions'] = array_values($item['conditions']);
|
||||
|
||||
$this->update($itemId, [
|
||||
'conditions' => $item['conditions'],
|
||||
]);
|
||||
@@ -527,7 +494,10 @@ public function clearItemConditions($itemId)
|
||||
*/
|
||||
public function clearCartConditions(): void
|
||||
{
|
||||
$this->session->putConditions([]);
|
||||
$this->session->put(
|
||||
$this->sessionKeyCartConditions,
|
||||
[]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -561,10 +531,14 @@ 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);
|
||||
@@ -630,14 +604,10 @@ public function getTotal(): int|float
|
||||
return Helpers::formatValue($subTotal, $this->config['format_numbers'], $this->config);
|
||||
}
|
||||
|
||||
$index = 0;
|
||||
|
||||
$conditionsForTotal->each(function (CartCondition $condition) use ($subTotal, &$total, &$index) {
|
||||
$toBeCalculated = ($index > 0) ? $total : $subTotal;
|
||||
$conditionsForTotal->each(function (CartCondition $condition) use ($subTotal, &$total) {
|
||||
$toBeCalculated = $total > 0 ? $total : $subTotal;
|
||||
|
||||
$total = $condition->applyCondition($toBeCalculated);
|
||||
|
||||
$index++;
|
||||
});
|
||||
|
||||
return Helpers::formatValue($total, $this->config['format_numbers'], $this->config);
|
||||
@@ -685,16 +655,24 @@ public function getTotalQuantity()
|
||||
return $count;
|
||||
}
|
||||
|
||||
public function getContent(): CartCollection
|
||||
/**
|
||||
* get the cart
|
||||
*
|
||||
* @return CartCollection
|
||||
*/
|
||||
public function getContent()
|
||||
{
|
||||
return (new CartCollection($this->session->getItems()))->transform(function ($item) {
|
||||
return $item instanceof ItemCollection ? $item : new ItemCollection($item, $this->config);
|
||||
})->reject(function ($item) {
|
||||
return (new CartCollection($this->session->get($this->sessionKeyCartItems)))->reject(function ($item) {
|
||||
return ! ($item instanceof ItemCollection);
|
||||
});
|
||||
}
|
||||
|
||||
public function isEmpty($test = null)
|
||||
/**
|
||||
* check if cart is empty
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isEmpty()
|
||||
{
|
||||
return $this->getContent()->isEmpty();
|
||||
}
|
||||
@@ -740,7 +718,7 @@ protected function validate($item)
|
||||
*/
|
||||
protected function addItem($id, $item)
|
||||
{
|
||||
if ($this->fireEvent('Adding', 'item', $item) === false) {
|
||||
if ($this->fireEvent('adding', $item) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -750,7 +728,7 @@ protected function addItem($id, $item)
|
||||
|
||||
$this->save($cart);
|
||||
|
||||
$this->fireEvent('Added', 'item', $item);
|
||||
$this->fireEvent('added', $item);
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -762,7 +740,7 @@ protected function addItem($id, $item)
|
||||
*/
|
||||
protected function save($cart)
|
||||
{
|
||||
$this->session->putItems($cart);
|
||||
$this->session->put($this->sessionKeyCartItems, $cart);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -770,7 +748,7 @@ protected function save($cart)
|
||||
*/
|
||||
protected function saveConditions($conditions)
|
||||
{
|
||||
$this->session->putConditions($conditions);
|
||||
$this->session->put($this->sessionKeyCartConditions, $conditions);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -841,19 +819,12 @@ public function setDecimals($decimals)
|
||||
$this->decimals = $decimals;
|
||||
}
|
||||
|
||||
protected function fireEvent($name, $type = null, $data = null)
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
protected function fireEvent($name, $value = [])
|
||||
{
|
||||
$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);
|
||||
return $this->events->dispatch($this->getInstanceName() . '.' . $name, array_values([$value, $this]), true);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -35,19 +35,24 @@ public function register()
|
||||
$this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'cart');
|
||||
|
||||
$this->app->singleton('cart', function ($app) {
|
||||
$config = config('cart');
|
||||
$events = $app['events'];
|
||||
$storageClass = config('cart.storage');
|
||||
$eventsClass = config('cart.events');
|
||||
|
||||
$storage = $config['driver'] === 'database'
|
||||
? new $config['storage']['database']['model']
|
||||
: $app['session'];
|
||||
$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';
|
||||
|
||||
return new Cart(
|
||||
$storage,
|
||||
$events,
|
||||
'cart',
|
||||
session()->getId(),
|
||||
$config
|
||||
$instanceName,
|
||||
$session_key,
|
||||
config('cart')
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
@@ -1,174 +0,0 @@
|
||||
<?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,40 +3,10 @@
|
||||
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(): string
|
||||
protected static function getFacadeAccessor()
|
||||
{
|
||||
return 'cart';
|
||||
}
|
||||
|
||||
+4
-34
@@ -91,37 +91,7 @@ public function getConditions()
|
||||
return [];
|
||||
}
|
||||
|
||||
$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;
|
||||
return $this['conditions'];
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -138,14 +108,14 @@ public function getPriceWithConditions($formatted = true)
|
||||
$processed = 0;
|
||||
|
||||
if ($this->hasConditions()) {
|
||||
if (is_array($this->getConditions())) {
|
||||
foreach ($this->getConditions() as $condition) {
|
||||
if (is_array($this->conditions)) {
|
||||
foreach ($this->conditions as $condition) {
|
||||
($processed > 0) ? $toBeCalculated = $newPrice : $toBeCalculated = $originalPrice;
|
||||
$newPrice = $condition->applyCondition($toBeCalculated);
|
||||
$processed++;
|
||||
}
|
||||
} else {
|
||||
$newPrice = $this->getConditions()->applyCondition($originalPrice);
|
||||
$newPrice = $this['conditions']->applyCondition($originalPrice);
|
||||
}
|
||||
|
||||
return Helpers::formatValue($newPrice, $formatted, $this->config);
|
||||
|
||||
@@ -4,5 +4,6 @@
|
||||
'format_numbers' => true,
|
||||
'decimals' => 2,
|
||||
'dec_point' => '.',
|
||||
'driver' => 'session',
|
||||
'thousands_sep' => ',',
|
||||
'use_cents' => false,
|
||||
];
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
<?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,5 +4,4 @@
|
||||
'format_numbers' => true,
|
||||
'decimals' => 2,
|
||||
'round_mode' => 'up',
|
||||
'driver' => 'session',
|
||||
];
|
||||
|
||||
@@ -4,5 +4,5 @@
|
||||
'format_numbers' => false,
|
||||
'decimals' => 3,
|
||||
'dec_point' => ',',
|
||||
'driver' => 'session',
|
||||
'thousands_sep' => '.',
|
||||
];
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
<?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,9 +20,4 @@ public function put($key, $value)
|
||||
{
|
||||
$this->session[$key] = $value;
|
||||
}
|
||||
|
||||
public function forget($key)
|
||||
{
|
||||
unset($this->session[$key]);
|
||||
}
|
||||
}
|
||||
|
||||
+26
-2
@@ -1,5 +1,29 @@
|
||||
<?php
|
||||
|
||||
use Tests\TestCase;
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| 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.
|
||||
|
|
||||
*/
|
||||
|
||||
uses(TestCase::class)->in(__DIR__);
|
||||
// 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);
|
||||
});
|
||||
|
||||
+2
-44
@@ -1,52 +1,10 @@
|
||||
<?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;
|
||||
|
||||
class TestCase extends BaseTestCase
|
||||
abstract 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();
|
||||
});
|
||||
}
|
||||
//
|
||||
}
|
||||
|
||||
@@ -119,7 +119,7 @@
|
||||
|
||||
// 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');
|
||||
expect($this->cart->getConditions()[0]->getName())->toEqual('Mother\'s Day Gift Pack');
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1065,7 +1065,7 @@
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(90, 'Cart should have total of 90');
|
||||
|
||||
$this->cart->clearItems();
|
||||
$this->cart->clear();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
@@ -1099,7 +1099,7 @@
|
||||
|
||||
expect($this->cart->getTotal())->toEqual(90, 'Cart should have total of 90');
|
||||
|
||||
$this->cart->clearItems();
|
||||
$this->cart->clear();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
@@ -1201,7 +1201,7 @@
|
||||
|
||||
expect($this->cart->getConditions(active: true))->toHaveCount(0, 'Cart should have 0 conditions');
|
||||
|
||||
$this->cart->clearItems();
|
||||
$this->cart->clear();
|
||||
|
||||
$this->cart->add([
|
||||
'id' => 1,
|
||||
@@ -1310,7 +1310,7 @@
|
||||
|
||||
// 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');
|
||||
expect($this->cart->get(1)['conditions'][0]->getName())->toEqual('Mother\'s Day Gift Pack');
|
||||
});
|
||||
|
||||
test('can add item with multiple negative item conditions', function () {
|
||||
|
||||
@@ -689,15 +689,3 @@
|
||||
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('LaravelCart.Created', Mockery::type('array'), true);
|
||||
$events->shouldReceive('dispatch')->once()->with('cart.created', Mockery::type('array'), true);
|
||||
|
||||
$cart = new Cart(
|
||||
new SessionMock,
|
||||
@@ -25,10 +25,10 @@
|
||||
});
|
||||
|
||||
test('event cart adding', function () {
|
||||
$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);
|
||||
$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);
|
||||
|
||||
$cart = new Cart(
|
||||
new SessionMock,
|
||||
@@ -44,10 +44,10 @@
|
||||
});
|
||||
|
||||
test('event cart adding multiple times', function () {
|
||||
$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);
|
||||
$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);
|
||||
|
||||
$cart = new Cart(
|
||||
new SessionMock,
|
||||
@@ -64,10 +64,10 @@
|
||||
});
|
||||
|
||||
test('event cart adding multiple times scenario two', function () {
|
||||
$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 = 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);
|
||||
|
||||
$items = [
|
||||
[
|
||||
@@ -107,12 +107,12 @@
|
||||
});
|
||||
|
||||
test('event cart remove item', function () {
|
||||
$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);
|
||||
$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);
|
||||
|
||||
$items = [
|
||||
[
|
||||
@@ -154,12 +154,12 @@
|
||||
});
|
||||
|
||||
test('event cart clear', function () {
|
||||
$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);
|
||||
$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);
|
||||
|
||||
$items = [
|
||||
[
|
||||
|
||||
@@ -1,126 +0,0 @@
|
||||
<?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');
|
||||
});
|
||||
});
|
||||
@@ -1,14 +0,0 @@
|
||||
<?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