Download the PHP package michael-rubel/laravel-couponables without Composer

Laravel Couponables

This package provides coupons/promocodes functionality for your Laravel application leveraging Eloquent's polymorphic relationships.

The package requires PHP 8.1 or higher and Laravel 10 or higher.

StandWithUkraine

Installation

Install the package using composer:

Publish the migrations:

Publish the config file:

Usage

After publishing migrations, apply a trait in the model you want to use as a $redeemer:

Artisan command

You can add coupons to your database using Artisan command:

Optionally, you can pass the next arguments:

Adding coupons using model

You can as well add coupons simply using model:

• Note: type and value columns are used for cost calculations (this is optional).\ If the type column is null, the subtraction strategy will be chosen.

Basic operations

Verify the coupon code:

Redeem the coupon:

Redeem the coupon in context of another model:

Combined redeemCoupon and for behavior (assuming the $course includes HasCoupons trait):

If something's going wrong, methods verifyCoupon and redeemCoupon will throw an exception:

If you want to bypass the exception and do something else:

Redeemer checks

Check if this coupon is already used by the model:

Check if the coupon is over the limit for the model:

Coupon checks

This method references the model assigned to redeem the coupon:

Calculations

The package supports three types of item cost calculations:

• subtraction - subtracts the given value from the value defined in the coupon model;
• percentage - subtracts the given value by the percentage defined in the coupon model;
• fixed - completely ignores the given value and takes the coupon model value instead.

Note: you can find constants for coupon types in the CouponContract

Listeners

If you go event-driven, you can handle package events:

• CouponVerified
• CouponRedeemed
• CouponExpired
• CouponIsOverLimit
• CouponIsOverQuantity
• NotAllowedToRedeem

Extending package functionality

Traits DefinesColumns and DefinesPivotColumns contain the methods that define column names to use by the package, so you can use inheritance to override them.

If you need to override the entire classes, use the config values or container bindings. All the classes in the package have their own contract (interface), so you're free to modify it as you wish.

CouponService has the Macroable trait, This way you can inject the methods to interact with the service without overriding anything.

Contributing

If you see any ways we can improve the package, PRs are welcome. But remember to write tests for your use cases.

Testing