Download the PHP package boddasaad/laravel-discountable without Composer
On this page you can find all versions of the php package boddasaad/laravel-discountable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download boddasaad/laravel-discountable
More information about boddasaad/laravel-discountable
Files in boddasaad/laravel-discountable
Package laravel-discountable
Short Description Allow your laravel models to redeem vouchers and apply discounts.
License MIT
Homepage https://github.com/boddasaad/laravel-discountable
Informations about the package laravel-discountable
Discountable
Make your models discountable with Laravel, allowing you to apply vouchers with lots of options and conditions. Here's a quick example of how to use the package:
Installation
You can install the package via composer:
This is the contents of the published config file:
Usage
To use the package, you need to add the CanRedeemVouchers
trait to your model:
Creating Vouchers
You can create vouchers using the Voucher
Facade. Here's an example of how to create a voucher with various options:
Voucher Facade Methods
Method | Description |
---|---|
discount(type, value) |
If type is percentage , value should be between 0 and 100. If type is fixed , value should be a positive number. |
maximumRedeems(int $max) |
This limits how many times the voucher can be redeemed in total. |
date(start, end) |
Both dates should be in Y-m-d format. The voucher will be valid between these dates. |
minimumQualifyingAmount(n) |
This is the minimum amount that must be spent to apply the voucher. |
maximumDiscountAmount(n) |
This limits the discount to a maximum value. For percentage discounts, this is the maximum amount that can be discounted. |
maxUsagesPerModel(n) |
This limits how many times a single model can use the voucher. |
data(array $data) |
This can be any additional information you want to store with the voucher, such as a description or terms and conditions. |
prefix(string $prefix) |
This allows you to specify a prefix for the voucher code dynamically. |
suffix(string $suffix) |
This allows you to specify a suffix for the voucher code dynamically. |
separator(string $sep) |
This allows you to specify a custom separator for the voucher code dynamically. |
create() |
This method will generate the voucher code and save it to the database. (MUST BE CALLED LAST) |
Applying Vouchers
To apply a voucher, you can use the checkVoucher
and redeemVoucher
methods provided by the CanRedeemVouchers
trait.
Check Voucher Validity
This is useful for UI validation before applying the voucher so the user can see if the voucher is valid or not.:
This will return an object with the following properties if the voucher is valid:
If the voucher is not valid, it will return an object with the following properties:
Redeem Voucher
To redeem the voucher and apply the discount, you can use the redeemVoucher
method:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Abdur-Rahman Saad
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-discountable with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^10.0||^11.0||^12.0