README

Laravel 5.* 推广代码生成器。致力于制作该类别的最佳包。欢迎加入这个派对，给我一些建议🎉并提交pull请求。

目录

• 安装
• 配置
• 用法
  • 基本方法
  • 用户特征
  • 附加数据
• 测试
• 许可证

新功能？

• 附加数据

安装

使用Composer安装此包

$ composer require tankonyako/promocodes

如果您使用的是Laravel 5.5或更高版本，则安装完成。否则请按照以下步骤操作。

打开 config/app.php 并按照以下步骤操作

找到 providers 数组并添加我们的服务提供者。

'providers' => [
    // ...
    Gabievi\Promocodes\PromocodesServiceProvider::class
],

找到 aliases 数组并添加我们的外观。

'aliases' => [
    // ...
    'Promocodes' => Gabievi\Promocodes\Facades\Promocodes::class
],

配置

使用Artisan命令发布配置和迁移文件

$ php artisan vendor:publish

要创建数据库中的推广代码表，请运行

$ php artisan migrate

配置参数有很好的文档。此处无需描述每个参数。

检查 config/promocodes.php 并阅读那里的注释，如有需要。

用法

生成尽可能多的代码，并将它们输出到数据库中。

您将获得一个包含代码的数组作为返回值

Promocodes::output($amount = 1);

参数

创建尽可能多的代码。设置奖励（金额）。

附加数组数据。指定这些代码应存活多少天。

默认生成的代码将是多用户（多个用户可以一次使用此代码）。

它们将被保存到数据库中，您将返回它们的集合

Promocodes::create($amount = 1, $reward = null, array $data = [], $expires_in = null, $quantity = null, $is_disposable = false);

如果您想创建只能使用一次的代码，这里有为您的方法。

Promocodes::createDisposable($amount = 1, $reward = null, array $data = [], $expires_in = null, $quantity = null);

参数

检查给定的代码是否存在，是否可用且尚未过期。

如果有效，返回 Promocode 对象，否则返回 false。

Promocodes::check($code);

参数

如果您想检查用户是否试图第二次使用推广代码，可以调用 Promocodes::isSecondUsageAttempt 并将 Promocode 对象作为参数传递。您将得到一个布尔值作为回答。

兑换或应用代码。兑换是应用方法的别名。

用户必须经过身份验证才能兑换代码，否则此方法将抛出异常（\Gabievi\Promocodes\Exceptions\UnauthenticatedException）。

如果经过身份验证的用户尝试两次应用代码，它将抛出异常（\Gabievi\Promocodes\Exceptions\AlreadyUsedException）

如果应用成功，返回 Promocode 对象，否则返回 false。

Promocodes::redeem($code);
Promocodes::apply($code);

参数

获取有效推广代码的集合。

Promocodes::all();

您可以立即通过调用 disable 函数来使代码失效。返回更新的布尔状态。

Promocodes::disable($code);

参数

如果您想删除过期的或不可用的代码，可以删除它们。

此方法将从数据库中删除冗余代码及其与用户的关联。

Promocodes::clearRedundant();

推广代码可以与用户相关联

如果您想使用用户关系，请打开 app/User.php 并将其设置为 Rewardable，如示例所示

namespace App;

use Illuminate\Notifications\Notifiable;
use Gabievi\Promocodes\Traits\Rewardable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use Notifiable, Rewardable;

    // ...
}

兑换或应用代码是相同的。《redeemCode》是《applyCode》的别名

传递要由当前用户应用的推广代码。

User::redeemCode($code, $callback = null);
User::applyCode($code, $callback = null);

示例（使用回调）

$redeemMessage = $user->redeemCode('ABCD-DCBA', function ($promocode) use ($user) {
    return 'Congratulations, ' . $user->name . '! We have added ' . $promocode->reward . ' points on your account';
});

// Congratulations, Zura! We have added 10 points on your account

如何使用附加数据？

1. 创建过程

Promocodes::create(1, 25, ['foo' => 'bar', 'baz' => 'qux']);

1. 获取数据回

Promocodes::redeem('ABC-DEF', function($promocode) {
    echo $promocode->data['foo'];
});

// bar

或

User::redeemCode('ABC-DEF', function($promocode) {
    echo $promocode->data['foo'];
});

// bar

测试

最后，它在这里。我编写了一些测试来保持此包健康和稳定

许可证

laravel-promocodes 在MIT许可证下授权。