Download the PHP package enea/laravel-cashier without Composer

Deprecated - Laravel Cashier Package

This repository is marked as deprecated and has been replaced by a better and more comprehensive version.

Reason: We have released Swift Cart, which offers enhanced functionalities, a more user-friendly experience, and improved performance. As a result, this repository will no longer receive updates.

Deprecation Date: August 4st, 2023.

This package provides a functionality to manage the sale of products and abstracts all the calculations you need for a sale.

Installation

Laravel Cashier requires PHP 7.4. This version supports Laravel 7

To get the latest version, simply require the project using Composer:

And publish the configuration file.

Class reference

This table defines the implementation of the models necessary for the operation of the package, there are some models that come to help such as: $discount and $document, however it is recommended to replace these models with your own.

Usage

To start a purchase you must use the ShoppingManager::initialize($client, $document).

When you initialize a shopping cart, a token is generated so that it can be searched from ShoppingManager::find($token). This function gets the shopping cart from session.

It is also possible that you want to invoice a quote, and to do so you must call the attach function of the $shoppingCart. Doing this creates a QuoteManager instance inside the Shopping Cart, which can be accessed from the $shoppingCart->getQuoteManager() function.

Now you just have to add products to the shopping cart using $shoppingCart->push($product, $quantity).

Or you can also pull products from the quote using $shoppingCart->pull($productID).

The push and pull methods returns an instance of ProductCartItem, which provides a lot of useful method.

Example

For this example, we are going to simulate a simple purchase. We need a $client and we will use a $invoice with IVA as a sales document.

Now we add a controller to manage shopping cart products.

And to finish we save the document in the database.

Cashier

It is responsible for centralizing the calculations to get taxes, discounts and totals for each product. you can find it in Enea\Cashier\Calculations\Cashier.

Pricing

Cashier separates the prices into 3, getGrossUnitPrice(), getNetUnitPrice() and getUnitPrice(), where the latter is the unit price after evaluating taxes, both included and excluded. $cashier->getUnitPrice() is the function used for all calculations. You can see an example in code from Enea\Tests\Calculations\PriceTest

Configuration

There are a few things you need to know to set up taxes and discounts correctly.

• Enea\Cashier\Modifiers\DiscountContract

  Represents an applicable discount. There is quite a functional helper implementation in Enea\Cashier\Modifiers\Discount so it is not totally necessary to assign your own model, unless you want full control over the discount codes.

• Enea\Cashier\Contracts\DocumentContract

  Represents the type of document with which the sale will be made and also defines the taxes that will be applied to the products.

• Enea\Cashier\Modifiers\TaxContract

  Represents the tax on the product, the package has a help implementation which can be found in Enea\Cashier\Modifiers\Tax

  To use taxes it is necessary to understand that they can be configured in 2 ways, included and excluded

  Type	INCLUDED	EXCLUDED
  Unit Price	100.00 $USD	100.00 $USD
  Tax %	10%	10%
  Total Tax	9.09 $USD	10.00 $USD
  Net Price	100.00 $USD	110.00 $USD

More documentation

You can find a lot of comments within the source code as well as the tests located in the tests directory.