abdelrhman3essa / laravel-promocodes
:package_description
9.1.0
2022-07-11 15:28 UTC
Requires
- php: ^8.1
- illuminate/broadcasting: ^9.0
- illuminate/console: ^9.0
- illuminate/container: ^9.0
- illuminate/database: ^9.0
- illuminate/queue: ^9.0
- illuminate/support: ^9.0
Requires (Dev)
- nunomaduro/larastan: ^2.0
- orchestra/testbench: ^7.1
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.2
- pestphp/pest-plugin-mock: ^1.0
- phpunit/phpunit: ^9.0
README
laravel-promocodes
Laravel优惠券和促销代码生成器。当前版本仅适用于Laravel 9.x和PHP 8.1。它已完全重写,如果你正在使用旧版本,你应该相应地更改你的代码。代码现在更加简化,完全重写使用可能只需几分钟。
注意:当前版本已完全重写。如果你缺少在旧版本中可以实现的某些功能,请随时提交问题。希望这个新版本更容易使用,并能更好地满足你的需求。
安装
您可以通过composer安装此软件包
composer require zgabievi/laravel-promocodes
配置
php artisan vendor:publish --provider="Zorb\Promocodes\PromocodesServiceProvider"
现在您可以按需更改配置
return [ 'models' => [ 'promocodes' => [ 'model' => \Zorb\Promocodes\Models\Promocode::class, 'table_name' => 'promocodes', 'foreign_id' => 'promocode_id', ], 'users' => [ 'model' => \App\Models\User::class, 'table_name' => 'users', 'foreign_id' => 'user_id', ], 'pivot' => [ 'model' => \Zorb\Promocodes\Models\PromocodeUser::class, 'table_name' => 'promocode_user', ], ], 'code_mask' => '****-****', 'allowed_symbols' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789', ];
配置此文件后,运行迁移
php artisan migrate
现在您需要在您的用户模型上使用AppliesPromocode。
namespace App\Models; use Illuminate\Foundation\Auth\User as Authenticatable; use Zorb\Promocodes\Traits\AppliesPromocode; class User extends Authenticatable { use AppliesPromocode; // }
用法
使用非常简单。方法已合并,因此您可以轻松配置促销代码。
参考
创建促销代码
使用类
根据需要组合方法。您可以跳过任何不需要的方法,其中大多数已有默认值。
use Zorb\Promocodes\Facades\Promocodes; Promocodes::mask('AA-***-BB') // default: config('promocodes.code_mask') ->characters('ABCDE12345') // default: config('promocodes.allowed_symbols') ->multiUse() // default: false ->unlimited() // default: false ->boundToUser() // default: false ->user(User::find(1)) // default: null ->count(5) // default: 1 ->usages(5) // default: 1 ->expiration(now()->addYear()) // default: null ->details([ 'discount' => 50 ]) // default: [] ->create();
使用助手函数
有一个全局助手函数,其功能与Promocodes类相同。您可以从PHP 8.1中使用命名参数魔法。
createPromocodes( mask: 'AA-***-BB', // default: config('promocodes.code_mask') characters: 'ABCDE12345', // default: config('promocodes.allowed_symbols') multiUse: true, // default: false unlimited: true, // default: false boundToUser: true, // default: false user: User::find(1), // default: null count: 5, // default: 1 usages: 5, // default: 1 expiration: now()->addYear(), // default: null details: [ 'discount' => 50 ] // default: [] );
使用命令
还有一个用于创建促销代码的命令。这里的参数也是可选的。
php artisan promocodes:create\ --mask="AA-***-BB"\ --characters="ABCDE12345"\ --multi-use\ --unlimited\ --bound-to-user\ --user=1\ --count=5\ --usages=5\ --expiration="2022-01-01 00:00:00"
生成促销代码
如果您想输出促销代码而不是将其保存到数据库,可以调用generate方法而不是create。
use Zorb\Promocodes\Facades\Promocodes; Promocodes::mask('AA-***-BB') // default: config('promocodes.code_mask') ->characters('ABCDE12345') // default: config('promocodes.allowed_symbols') ->multiUse() // default: false ->unlimited() // default: false ->boundToUser() // default: false ->user(User::find(1)) // default: null ->count(5) // default: 1 ->usages(5) // default: 1 ->expiration(now()->addYear()) // default: null ->details([ 'discount' => 50 ]) // default: [] ->generate();
应用促销代码
使用类
根据需要组合方法。您可以跳过任何不需要的方法。
use Zorb\Promocodes\Facades\Promocodes; Promocodes::code('ABC-DEF') ->user(User::find(1)) // default: null ->apply();
使用助手函数
有一个全局助手函数,其功能与Promocodes类相同。
applyPomocode( 'ABC-DEF', User::find(1) // default: null );
使用命令
还有一个用于应用促销代码的命令。
php artisan promocodes:apply ABC-DEF --user=1
异常
在尝试应用促销代码时,您应该注意异常。代码的大部分部分在有问题时会抛出异常
// Zorb\Promocodes\Exceptions\* PromocodeAlreadyUsedByUserException - "The given code `ABC-DEF` is already used by user with id 1." PromocodeBoundToOtherUserException - "The given code `ABC-DEF` is bound to other user, not user with id 1." PromocodeDoesNotExistException - "The given code `ABC-DEF` doesn't exist." | "The code was not event provided." PromocodeExpiredException - "The given code `ABC-DEF` already expired." PromocodeNoUsagesLeftException - "The given code `ABC-DEF` has no usages left." UserHasNoAppliesPromocodeTrait - "The given user model doesn't have AppliesPromocode trait." UserRequiredToAcceptPromocode - "The given code `ABC-DEF` requires to be used by user, not by guest."
事件
有两个事件在应用时被触发。
// Zorb\Promocodes\Events\* GuestAppliedPromocode // Fired when guest applies promocode // It has public variable: promocode UserAppliedPromocode // Fired when user applies promocode // It has public variable: promocode // It has public variable: user
过期促销代码
使用助手函数
有一个全局助手函数可以过期促销代码。
expirePromocode('ABC-DEF');
使用命令
还有一个用于过期促销代码的命令。
php artisan promocodes:expire ABC-DEF
特质方法
如果您已将AppliesPromocode特质添加到您的用户模型,您将在用户上获得一些额外的方法。
$user = User::find(1); $user->appliedPromocodes // Returns promocodes applied by user $user->boundPromocodes // Returns promocodes bound to user $user->applyPromocode('ABC-DEF') // Applies promocode to user
其他方法
Promocodes::all(); // To retrieve all (available/not available) promocodes Promocodes::available(); // To retrieve valid (available) promocodes Promocodes::notAvailable(); // To retrieve invalid (not available) promocodes
测试
composer test
贡献
请参阅贡献指南以获取详细信息。
鸣谢
许可
MIT许可(MIT)。请参阅许可文件以获取更多信息。