lakshmaji/plans

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

维护者

详情

github.com/lakshmaji/plans

主页

源代码

问题

安装: 9

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

dev-master 2020-04-18 14:52 UTC

Requires

Requires (Dev)

MIT 91c9db010aa562dfb42c944b5bb8496667e9a9b7

modelsubscriptionlaravelsaasplaneloquentplans

This package is auto-updated.

Last update: 2024-09-06 01:03:40 UTC

README

Laravel Plans

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

Laravel Cashier

虽然Laravel Cashier这项工作做得很好，但还有一些SaaS应用程序可能有用的功能

  • 可计数的、有限的功能 - 如果你计划限制订阅者可以拥有的资源数量并跟踪使用情况，这个软件包可以为你做到这一点。
  • 内置可定制周期性，可自定义周期性周期 - 当Stripe或其他服务限制你每天、每周、每月或每年订阅用户时，这个软件包让你可以为自己定义任何订阅或计划的任何天数。
  • 基于事件的本质 - 你可以监听事件。如果你的用户按时支付发票，你能否给他们提供3天免费试用期？

安装

安装软件包

$ composer require rennokki/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 订单功能，有助于您在订阅时或在需求时对订阅者进行收费，在处理 周期性 时。

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

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

使用 Stripe

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

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

  • 扩展或升级不会向用户收费，只有订阅方法会自动为您这样做，如果您告诉了该包这样做。您希望在订阅开始时向用户收费，因此您必须遍历所有订阅者并检查其订阅是否已过期，然后在 cronned 命令中自动续订。

  • 您必须传递 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 Token 来从该用户进行充值。由于 Stripe Token 是一次性使用的，您必须管理从用户那里获取 Token。

$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 Token。

$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.
    ],
];