README

此包基于

此包基于 https://github.com/rennokki/plans

Laravel Plans

Laravel Plans 是一个用于需要管理计划、功能、订阅、计划或有限、可计数的功能的 SaaS 应用程序的包。

Laravel Cashier

虽然 Laravel Cashier 可以很好地完成这项工作，但还有一些功能对 SaaS 应用程序可能很有用

• 可计数的、有限的功能 - 如果您计划限制订阅者可以拥有的资源数量并跟踪使用情况，此包可以为您完成。
• 内置周期性，可自定义的周期 - 虽然 Stripe 或限制您每天、每周、每月或按年订阅用户，但此包允许您为任何订阅或计划定义自己的天数。
• 基于事件驱动 - 您可以监听事件。如果用户按时支付账单，您是否可以为下一个订阅提供 3 天免费试用期？

安装

安装包

$ composer require vinyvicente/plans

如果您的 Laravel 版本不支持包发现，请在您的 config/app.php 文件中的 providers 数组中添加此行

Rennokki\Plans\PlansServiceProvider::class,

发布配置文件和迁移文件

$ php artisan vendor:publish

迁移数据库

$ php artisan migrate

将 HasPlans 特性添加到您的 Eloquent 模型

use Rennokki\Plans\Traits\HasPlans;

class User extends Model {
    use HasPlans;
    ...
}

创建计划

类似于订阅的系统的基本单位是计划。您可以使用 Rennokki\Plans\Models\PlanModel 或您的模型（如果您已实现自己的模型）来创建它。

$plan = PlanModel::create([
    'name' => 'Enterprise',
    'description' => 'The biggest plans of all.',
    'price' => 20.99,
    'currency' => 'EUR',
    'duration' => 30, // in days
    'metadata' => ['key1' => 'value1', ...],
]);

功能

每个计划都有功能。它们可以是可计数的，这些是有限的或无限的，或者只是存储信息，如特定权限。

可以使用以下方式标记功能类型

• feature，是一个不进行计数的单个字符串。例如，您可以存储权限。
• limit，是一个数字。对于此类功能，将填充 limit 属性。它旨在衡量用户在此订阅中消耗了多少此类功能。例如，您可以统计用户在一个月（或在此例中为 30 天的周期）内消耗了多少构建分钟。

注意：对于无限功能，将设置 limit 字段为任何负值。

要为您的计划附加功能，您可以使用关系 features() 并传递所需数量的 Rennokki\Plans\Models\PlanFeatureModel 实例。

$plan->features()->saveMany([
    new PlanFeatureModel([
        'name' => 'Vault access',
        'code' => 'vault.access',
        'description' => 'Offering access to the vault.',
        'type' => 'feature',
        'metadata' => ['key1' => 'value1', ...],
    ]),
    new PlanFeatureModel([
        'name' => 'Build minutes',
        'code' => 'build.minutes',
        'description' => 'Build minutes used for CI/CD.',
        'type' => 'limit',
        'limit' => 2000,
        'metadata' => ['key1' => 'value1', ...],
    ]),
    new PlanFeatureModel([
        'name' => 'Users amount',
        'code' => 'users.amount',
        'description' => 'The maximum amount of users that can use the app at the same time.',
        'type' => 'limit',
        'limit' => -1, // or any negative value
        'metadata' => ['key1' => 'value1', ...],
    ]),
    ...
]);

稍后，您可以直接从订阅中检索权限。

$subscription->features()->get(); // All features
$subscription->features()->code($codeId)->first(); // Feature with a specific code.
$subscription->features()->limited()->get(); // Only countable/unlimited features.
$subscription->features()->feature()->get(); // Uncountable, permission-like features.

订阅计划

您的用户可以订阅计划，为期一定天数或直到特定日期。

$subscription = $user->subscribeTo($plan, 30); // 30 days
$subscription->remainingDays(); // 29 (29 days, 23 hours, ...)

默认情况下，计划被标记为 recurring，因此如果计划续订，它将有效，如以下 周期性 部分所述。

如果您不希望进行周期性订阅，可以将 false 作为第三个参数传递。

$subscription = $user->subscribeTo($plan, 30, false); // 30 days, non-recurrent

如果您计划订阅用户直到特定日期，您可以传递包含日期、日期时间或 Carbon 实例的字符串。

如果您的订阅是周期性的，则周期性周期的天数是到期日期与当前日期之间的差异。

$user->subscribeToUntil($plan, '2018-12-21');
$user->subscribeToUntil($plan, '2018-12-21 16:54:11');
$user->subscribeToUntil($plan, Carbon::create(2018, 12, 21, 16, 54, 11));

$user->subscribeToUntil($plan, '2018-12-21', false); // no recurrency

注意：如果用户已经订阅，则 subscribeTo() 将返回 false。为了避免这种情况，请升级或扩展订阅。

升级订阅

当前订阅计划的升级可以通过两种方式完成：它要么将已过的天数扩展到当前订阅中，要么创建另一个订阅，作为当前订阅的延伸。

无论哪种方式，您都必须传递一个布尔值作为第三个参数。默认情况下，它会扩展当前订阅。

// The current subscription got longer with 60 days.
$currentSubscription = $user->upgradeCurrentPlanTo($anotherPlan, 60, true);

// A new subscription, with 60 days valability, starting when the current one ends.
$newSubscription = $user->upgradeCurrentPlanTo($anotherPlan, 60, false);

就像订阅方法一样，升级也支持将日期作为第三个参数，如果您计划在当前订阅结束后创建新的订阅。

$user->upgradeCurrentPlanToUntil($anotherPlan, '2018-12-21', false);
$user->upgradeCurrentPlanToUntil($anotherPlan, '2018-12-21 16:54:11', false);
$user->upgradeCurrentPlanToUntil($anotherPlan, Carbon::create(2018, 12, 21, 16, 54, 11), false);

如果您的第三个参数是 false，则可以传递第四个参数，如果您想将新的订阅标记为可续订的话。

// Creates a new subscription that starts at the end of the current one, for 30 days and recurrent.
$newSubscription = $user->upgradeCurrentPlanTo($anotherPlan, 30, false, true);

扩展当前订阅

升级使用扩展方法，所以它使用相同的参数，但您不需要将计划模型作为第一个参数传递。

// The current subscription got extended with 60 days.
$currentSubscription = $user->extendCurrentSubscriptionWith(60, true);

// A new subscription, which starts at the end of the current one.
$newSubscrioption = $user->extendCurrentSubscriptionWith(60, false);

// A new subscription, which starts at the end of the current one and is recurring.
$newSubscrioption = $user->extendCurrentSubscriptionWith(60, false, true);

扩展也支持日期。

$user->extendCurrentSubscriptionUntil('2018-12-21');

取消订阅

您可以取消订阅。如果订阅尚未完成（尚未过期），它将被标记为 挂起取消。当到期日期超过当前时间并且仍然处于取消状态时，它将完全取消。

// Returns false if there is not an active subscription.
$user->cancelCurrentSubscription();
$lastActiveSubscription = $user->lastActiveSubscription();

$lastActiveSubscription->isCancelled(); // true
$lastActiveSubscription->isPendingCancellation(); // true
$lastActiveSubscription->isActive(); // false

$lastActiveSubscription->hasStarted();
$lastActiveSubscription->hasExpired();

消耗可计数的特性

要消耗 limit 类型的特性，您必须在订阅实例内调用 consumeFeature() 方法。

要检索订阅实例，您可以在实现该特质的用户内调用 activeSubscription() 方法。作为预检查，不要忘记从用户实例调用 hasActiveSubscription() 来确保它已订阅。

if ($user->hasActiveSubscription()) {
    $subscription = $user->activeSubscription();
    $subscription->consumeFeature('build.minutes', 10);

    $subscription->getUsageOf('build.minutes'); // 10
    $subscription->getRemainingOf('build.minutes'); // 1990
}

consumeFeature() 方法将返回：

• false 如果特性不存在、特性不是 limit 类型或数量超出当前特性配额。
• true 如果消耗成功。

// Note: The remaining of build.minutes is now 1990

$subscription->consumeFeature('build.minutes', 1991); // false
$subscription->consumeFeature('build.hours', 1); // false
$subscription->consumeFeature('build.minutes', 30); // true

$subscription->getUsageOf('build.minutes'); // 40
$subscription->getRemainingOf('build.minutes'); // 1960

如果 consumeFeature() 遇到无限特性，它会消耗它，并像正常记录一样跟踪使用情况，但永远不会返回 false。对于无限特性，剩余值始终为 -1。

consumeFeature() 方法的逆操作是 unconsumeFeature()。这同样工作，但方向相反。

// Note: The remaining of build.minutes is 1960

$subscription->consumeFeature('build.minutes', 60); // true

$subscription->getUsageOf('build.minutes'); // 100
$subscription->getRemainingOf('build.minutes'); // 1900

$subscription->unconsumeFeature('build.minutes', 100); // true
$subscription->unconsumeFeature('build.hours', 1); // false

$subscription->getUsageOf('build.minutes'); // 0
$subscription->getRemainingOf('build.minutes'); // 2000

在无限特性上使用 unconsumeFeature() 方法也会减少使用，但永远不会达到负值。

支付

即使不显式使用集成的支付功能，此包也能正常工作。这是好事，因为本文档中之前解释的功能可以在不使用集成支付系统的情况下工作。如果您有自己的支付系统，您可以按自己的意愿使用它。确保检查下面的 可续订 部分，了解如何根据用户的最后订阅来收费以及如何处理一般可续订。

配置Stripe

此包包含一个Stripe Charge功能，帮助您在订阅时或按需处理 可续订 时向订阅者收费。

为了保持与Laravel Cashier一样优雅，您必须通过添加Stripe来配置 config/services.php 文件。

'stripe' => [
    'key' => env('STRIPE_KEY'),
    'secret' => env('STRIPE_SECRET'),
],

使用Stripe

如果您现在非常熟悉订阅、扩展、升级或取消订阅，而不需要显式传递支付方法，那么还有一些额外的功能可以让您控制支付。

• 计划的定价从您的 plans 表中获取。如果您想进行一些处理并设置另一个收费价格，您可以这样做。稍后将有解释。

• 扩展或升级不会向用户收费，只有订阅方法会自动为您这样做，如果您告诉包这样做的话。如果您想从订阅开始时向用户收费，那么您必须遍历所有订阅者并检查他们的订阅是否已过期，然后在一个定时命令（例如）中自动续订。

• 您必须传递一个Stripe令牌。每次您想要进行支付时，都需要传递一个Stripe令牌。此软件包通过为Stripe客户创建本地表来帮助您跟踪您的客户。

• 对于成功或失败的支付将触发事件。无需设置webhooks。事件由Stripe收费驱动，无论成功或失败。

使用Stripe收费订阅

要使用Stripe令牌订阅您的用户，您必须明确传递一个Stripe令牌

$user->withStripe()->withStripeToken('tok_...')->subscribeTo($plan, 53); // 53 days

默认情况下，收费金额从plans表检索。但是，您可以在过程中更改价格，具体取决于您的选择

$user->withStripe()->setChargingPriceTo(10, 'USD')->withStripeToken('tok_...')->subscribeTo($plan, 30);

无论计划的收费价格是多少，收费价格将是10美元，因为我们覆盖了收费价格。

由于extendCurrentSubscriptionWith()、extendCurrentSubscriptionUntil()、upgradeupgradeCurrentPlanTo()和upgradeCurrentPlanToUntil()与收费不兼容，使用withStripe()将不会有任何效果，除非您告诉它们创建一个新的计划，以扩展当前计划

// This will create a new upgraded plan that starts at the end of the current one, which is recurring and will be needed to be paid to be active.
$user->withStripe()->upgradeCurrentPlanTo($plan, 30, false, true);

请注意，即使如此，该方法也不会向用户收费，因为新的订阅尚未开始。由于新订阅将在当前订阅结束后开始，您必须手动收费，具体说明如下。

周期性

此软件包不支持Cashier支持的内容：Stripe计划和Stripe优惠券。此软件包使您能够成为主控者，而无需使用第三方来处理订阅和周期性。主要优势是可以定义自己的天数周期性金额，而Stripe受限于每日、每周、每月和每年。

要处理周期性，有一个名为renewSubscription的方法，它会为您完成这项工作。您将必须遍历所有您的订阅者。最好运行一个cron命令，该命令将调用每个订阅者的方法。

此方法将在需要时为用户更新订阅。

foreach(User::all() as $user) {
    $user->renewSubscription();
}

如果您使用集成的Stripe收费功能，您必须传递一个Stripe令牌来对该用户进行收费。由于Stripe令牌是一次性的（一次使用），您必须管理从您的用户那里获取令牌。

$user->renewSubscription('tok...');

与往常一样，如果支付处理成功，将触发Rennokki\Plans\Stripe\ChargeSuccessful事件；如果支付失败，将触发Rennokki\Plans\Stripe\ChargeFailed事件。

到期订阅

不使用本地Stripe收费功能的订阅永远不会标记为Due，因为它们都是默认付款的。

如果您的应用程序使用自己的支付方法，您可以为以下chargeForLastDueSubscription()方法传递一个闭包，这将帮助您控制到期订阅

$user->chargeForLastDueSubscription(function($subscription) {
    // process the payment here

    if($paymentSuccessful) {
        $subscription->update([
            'is_paid' => true,
            'starts_on' => Carbon::now(),
            'expires_on' => Carbon::now()->addDays($subscription->recurring_each_days),
        ]);
        
        return $subscription;
    }
    
    return null;
});

在支付失败时，它们将被标记为Due。它们需要付款，并且每个动作，如订阅、升级或扩展，都将始终尝试通过删除上一个未付款的订阅，创建一个在所提动作中提到的计划，并尝试付款。

为此，chargeForLastDueSubscription()将帮助您为最后一个未付款的订阅向用户收费。您必须明确传递一个Stripe令牌进行此操作

$user->withStripe()->withStripeToken('tok_...')->chargeForLastDueSubscription();

对于此方法，在成功收费或失败收费时，将抛出\Rennokki\Plans\Events\Stripe\DueSubscriptionChargeSuccess和\Rennokki\Plans\Events\Stripe\DueSubscriptionChargeFailed。

事件

当使用订阅计划时，您希望监听事件以自动运行可能会更改您的应用程序的代码。

事件很容易使用。如果您不熟悉，您可以查看Laravel官方文档中的事件。

您需要做的是在您的EventServiceProvider.php文件中实现以下事件。每个事件都将有自己的成员，可以在监听器的handle()方法中的$event变量中访问。

$listen = [
    ...
    \Rennokki\Plans\Events\CancelSubscription::class => [
        // $event->model = The model that cancelled the subscription.
        // $event->subscription = The subscription that was cancelled.
    ],
    \Rennokki\Plans\Events\NewSubscription::class => [
        // $event->model = The model that was subscribed.
        // $event->subscription = The subscription that was created.
    ],
     \Rennokki\Plans\Events\NewSubscriptionUntil::class => [
        // $event->model = The model that was subscribed.
        // $event->subscription = The subscription that was created.
    ],
    \Rennokki\Plans\Events\ExtendSubscription::class => [
        // $event->model = The model that extended the subscription.
        // $event->subscription = The subscription that was extended.
        // $event->startFromNow = If the subscription is exteded now or is created a new subscription, in the future.
        // $event->newSubscription = If the startFromNow is false, here will be sent the new subscription that starts after the current one ends.
    ],
    \Rennokki\Plans\Events\ExtendSubscriptionUntil::class => [
        // $event->model = The model that extended the subscription.
        // $event->subscription = The subscription that was extended.
        // $event->expiresOn = The Carbon instance of the date when the subscription will expire.
        // $event->startFromNow = If the subscription is exteded now or is created a new subscription, in the future.
        // $event->newSubscription = If the startFromNow is false, here will be sent the new subscription that starts after the current one ends.
    ],
    \Rennokki\Plans\Events\UpgradeSubscription::class => [
        // $event->model = The model that upgraded the subscription.
        // $event->subscription = The current subscription.
        // $event->startFromNow = If the subscription is upgraded now or is created a new subscription, in the future.
        // $event->oldPlan = Here lies the current (which is now old) plan.
        // $event->newPlan = Here lies the new plan. If it's the same plan, it will match with the $event->oldPlan
    ],
    \Rennokki\Plans\Events\UpgradeSubscriptionUntil::class => [
        // $event->model = The model that upgraded the subscription.
        // $event->subscription = The current subscription.
        // $event->expiresOn = The Carbon instance of the date when the subscription will expire.
        // $event->startFromNow = If the subscription is upgraded now or is created a new subscription, in the future.
        // $event->oldPlan = Here lies the current (which is now old) plan.
        // $event->newPlan = Here lies the new plan. If it's the same plan, it will match with the $event->oldPlan
    ],
    \Rennokki\Plans\Events\FeatureConsumed::class => [
        // $event->subscription = The current subscription.
        // $event->feature = The feature that was used.
        // $event->used = The amount used.
        // $event->remaining = The total amount remaining. If the feature is unlimited, will return -1
    ],
     \Rennokki\Plans\Events\FeatureUnconsumed::class => [
        // $event->subscription = The current subscription.
        // $event->feature = The feature that was used.
        // $event->used = The amount reverted.
        // $event->remaining = The total amount remaining. If the feature is unlimited, will return -1
    ],
    \Rennokki\Plans\Events\Stripe\ChargeFailed::class => [
        // $event->model = The model for which the payment failed.
        // $event->subscription = The subscription.
        // $event->exception = The exception thrown by the Stripe API wrapper.
    ],
    \Rennokki\Plans\Events\Stripe\ChargeSuccessful::class => [
        // $event->model = The model for which the payment succeded.
        // $event->subscription = The subscription which was updated as paid.
        // $event->stripeCharge = The response coming from the Stripe API wrapper.
    ],
    \Rennokki\Plans\Events\Stripe\DueSubscriptionChargeFailed::class => [
        // $event->model = The model for which the payment failed.
        // $event->subscription = The due subscription that cannot be paid.
        // $event->exception = The exception thrown by the Stripe API wrapper.
    ],
    \Rennokki\Plans\Events\Stripe\DueSubscriptionChargeSuccess::class => [
        // $event->model = The model for which the payment succeded.
        // $event->subscription = The due subscription that was paid.
        // $event->stripeCharge = The response coming from the Stripe API wrapper.
    ],
];