i-build-web-apps/operativeit-plans

Laravel Plans 是一个用于需要管理套餐、功能、订阅和计划的 SaaS 应用的包。

维护者

详细信息

github.com/i-build-web-apps/operativeit-plans

主页

源代码

安装: 3

依赖: 0

建议者: 0

安全: 0

星级: 0

关注者: 0

分支: 17

dev-master 2023-02-03 13:38 UTC

Requires

Requires (Dev)

MIT 3e684b92d5ad3c76aa1478be11cb399e2a9bfe04

modelsubscriptionlaravelsaasplaneloquentplans

This package is auto-updated.

Last update: 2024-09-30 01:36:30 UTC

README

Build Status codecov StyleCI Latest Stable Version Total Downloads Monthly Downloads License

PayPal

Laravel Plans

Laravel Plans 是一个用于需要管理套餐、功能、订阅和计划的 SaaS 应用的包。

Laravel Cashier

虽然 Laravel Cashier 完成这项工作非常好，但还有一些功能对于 SaaS 应用可能很有用

  • 可计数的限制性功能 - 如果你计划限制订阅者拥有的资源数量并跟踪使用情况，这个包会为你完成这项工作。
  • 内置可自定义的周期性 - 当 Stripe 或限制你允许用户按日、周、月或年订阅时，这个包让你可以为任何订阅或计划定义自己的天数。
  • 基于事件驱动 - 你可以监听事件。如果用户按时支付账单，你能给他们提供3天的免费服务吗？

安装

安装包

$ composer require creatydev/plans

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

IBuildWebApps\Plans\PlansServiceProvider::class,

发布配置文件和迁移文件

$ php artisan vendor:publish --provider=IBuildWebApps\Plans\PlansServiceProvider

迁移数据库

$ php artisan migrate

将 HasPlans 特性添加到你的 Eloquent 模型中

use IBuildWebApps\Plans\Traits\HasPlans;

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

创建计划

订阅类似系统的基本单位是计划。你可以使用 IBuildWebApps\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() 并传递所需的 IBuildWebApps\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->subscribeToPlan($plan, 30); // 30 days
$subscription->remainingDays(); // 29 (29 days, 23 hours, ...)

默认情况下，计划被标记为 recurring，因此它到期后可以扩展，如果计划这样做，请参阅下方的 周期性 部分。

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

$subscription = $user->subscribeToPlan($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

注意：如果用户已经订阅，则 subscribeToPlan() 将返回 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()。这与 consumeFeature() 的工作方式相同，但方向相反。

// 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 表中获取。 如果您想要进行一些处理并设置另一个收费价格，您可以这样做。稍后会有解释。

  • 扩展或升级不会向用户收费，只有订阅方法会自动为您这样做，如果您告诉包这样做的话。您希望用户从订阅开始时就开始收费，因此您必须遍历所有订阅者并检查他们的订阅是否过期，然后通过cron命令自动续订，例如。

  • 您必须传递一个Stripe令牌。每次您想要进行付款时都需要传递一个Stripe令牌。这个包通过有一个本地的Stripe Customers表来帮助您跟踪客户。

  • 事件在支付成功或失败时触发。无需设置webhook。事件由Stripe Charge驱动，无论成功还是失败。

使用Stripe Charge订阅

要使用Stripe Token订阅您的用户，您必须显式传递一个Stripe Token

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

默认情况下，计费金额从plans表检索。然而，您可以在过程中更改价格，由您决定

$user->withStripe()->setChargingPriceTo(10, 'USD')->withStripeToken('tok_...')->subscribeToPlan($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 Charge功能，您将必须传递一个Stripe Token来从该用户处收费。由于Stripe Tokens是一次性使用的，您将需要管理从您的用户那里获取令牌。

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

一如既往，如果支付成功，将触发IBuildWebApps\Plans\Stripe\ChargeSuccessful事件，如果支付失败，将触发IBuildWebApps\Plans\Stripe\ChargeFailed事件。

到期订阅

不使用本地Stripe Charge功能的订阅永远不会被标记为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();

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

模型扩展

您还可以扩展计划模型

注意 $table、$fillable、$cast、Relationships将继承

PlanModel

<?php
namespace App\Models;
use IBuildWebApps\Plans\Models\Plan;
class Plan extends Plan {
    //
}

PlanFeatureModel

<?php
namespace App\Models;
use IBuildWebApps\Plans\Models\PlanFeature;
class PlanFeature extends PlanFeature {
    //
}

PlanSubscriptionModel

<?php
namespace App\Models;
use IBuildWebApps\Plans\Models\PlanSubscription;
class PlanSubscription extends PlanSubscription {
    //
}

PlanSubscriptionUsageModel

<?php
namespace App\Models;
use IBuildWebApps\Plans\Models\PlanSubscriptionUsage;
class PlanSubscriptionUsage extends PlanSubscriptionUsage {
    //
}

StripteCustomerModel

<?php
namespace App\Models;
use IBuildWebApps\Plans\Models\StripteCustomerModel;
class StripeCustomer extends StripteCustomerModel {
    //
}

事件

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

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

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

$listen = [
    ...
    \IBuildWebApps\Plans\Events\CancelSubscription::class => [
        // $event->model = The model that cancelled the subscription.
        // $event->subscription = The subscription that was cancelled.
    ],
    \IBuildWebApps\Plans\Events\NewSubscription::class => [
        // $event->model = The model that was subscribed.
        // $event->subscription = The subscription that was created.
    ],
     \IBuildWebApps\Plans\Events\NewSubscriptionUntil::class => [
        // $event->model = The model that was subscribed.
        // $event->subscription = The subscription that was created.
    ],
    \IBuildWebApps\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.
    ],
    \IBuildWebApps\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.
    ],
    \IBuildWebApps\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
    ],
    \IBuildWebApps\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
    ],
    \IBuildWebApps\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
    ],
     \IBuildWebApps\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
    ],
    \IBuildWebApps\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.
    ],
    \IBuildWebApps\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.
    ],
    \IBuildWebApps\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.
    ],
    \IBuildWebApps\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.
    ],
];

作者

  • Georgescu Alexandru - 初始工作 .
  • Dukens Thelemaque - Laravel 5.8 - 6.2 支持 - IBuildWebApps

有关参与此项目的贡献者列表，请参阅。

许可证

本项目采用MIT许可证，有关详细信息请参阅LICENSE.md 文件。