README

Laravel Subscriptions

Laravel Subscriptions 是一个灵活的计划和订阅管理系统，专为 Laravel 设计，包含运行您的 SaaS 服务所需的工具，以高效运行。它具有简单架构，并配备强大的底层技术，为您的企业提供坚实的基础。

注意事项

• 本包不包含支付功能。
• 您可能需要扩展一些核心模型，例如您需要覆盖某些辅助方法（如 renew()、cancel() 等）的逻辑。例如：在取消订阅时，您可能还想取消关联的周期性支付。

安装

1. 使用 composer 安装此包

   composer require laravelcm/laravel-subscriptions

2. 发布资源（迁移和配置文件）

   php artisan publish:laravel-subscriptions

3. 使用以下命令执行迁移

   php artisan migrate

4. 完成！

用法

将订阅添加到用户模型中

Laravel Subscriptions 专门为 Eloquent 设计，并非常重视简洁性。要将订阅功能添加到您的用户模型中，只需使用 \Rinvex\Subscriptions\Traits\HasPlanSubscriptions 特性，如下所示

namespace App\Models;

use Laravelcm\Subscriptions\Traits\HasPlanSubscriptions;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

就是这样，我们只需要在我们的用户模型中使用这个特性！现在您的用户可以订阅计划了。

注意：您可以在任何订阅者模型上使用 HasPlanSubscriptions 特性，它不必是用户模型，实际上任何模型都可以。

创建一个计划

use Laravelcm\Subscriptions\Models\Plan;
use Laravelcm\Subscriptions\Models\Feature;
use Laravelcm\Subscriptions\Interval;

$plan = Plan::create([
    'name' => 'Pro',
    'description' => 'Pro plan',
    'price' => 9.99,
    'signup_fee' => 1.99,
    'invoice_period' => 1,
    'invoice_interval' => Interval::MONTH->value,
    'trial_period' => 15,
    'trial_interval' => Interval::DAY->value,
    'sort_order' => 1,
    'currency' => 'USD',
]);

// Create multiple plan features at once
$plan->features()->saveMany([
    new Feature(['name' => 'listings', 'value' => 50, 'sort_order' => 1]),
    new Feature(['name' => 'pictures_per_listing', 'value' => 10, 'sort_order' => 5]),
    new Feature(['name' => 'listing_duration_days', 'value' => 30, 'sort_order' => 10, 'resettable_period' => 1, 'resettable_interval' => 'month']),
    new Feature(['name' => 'listing_title_bold', 'value' => 'Y', 'sort_order' => 15])
]);

获取计划详情

您可以使用直观的 API 查询计划以获取更多详细信息，如下所示

use Laravelcm\Subscriptions\Models\Plan;

$plan = Plan::find(1);

// Get all plan features                
$plan->features;

// Get all plan subscriptions
$plan->planSubscriptions;

// Check if the plan is free
$plan->isFree();

// Check if the plan has trial period
$plan->hasTrial();

// Check if the plan has grace period
$plan->hasGrace();

$plan->features 和 $plan->planSubscriptions 都是集合，由关系驱动，因此您可以将这些关系查询为任何正常的 Eloquent 关系。例如 $plan->features()->where('name', 'listing_title_bold')->first()。

获取功能值

假设您想显示上面提到的功能 pictures_per_listing 的值。您可以通过多种方式做到这一点

use Laravelcm\Subscriptions\Models\Feature;
use Laravelcm\Subscriptions\Models\Subscription;

// Use the plan instance to get feature's value
$amountOfPictures = $plan->getFeatureBySlug('pictures_per_listing')->value;

// Query the feature itself directly
$amountOfPictures = Feature::where('slug', 'pictures_per_listing')->first()->value;

// Get feature value through the subscription instance
$amountOfPictures = Subscription::find(1)->getFeatureValue('pictures_per_listing');

创建一个订阅

您可以使用 HasPlanSubscriptions 特性中的 newSubscription() 函数来订阅用户的计划。首先，检索您的订阅者模型实例，通常是您的用户模型和用户要订阅的计划实例。一旦检索到模型实例，您可以使用 newSubscription 方法创建模型订阅。

use Laravelcm\Subscriptions\Models\Plan;
use App\Models\User;

$user = User::find(1);
$plan = Plan::find(1);

$user->newPlanSubscription('main', $plan);

newSubscription 方法传递的第一个参数应该是订阅的标题。如果您的应用程序提供单个订阅，您可能将其称为 main 或 primary，第二个参数是用户订阅的计划实例，还有一个可选的第三个参数可以指定自定义开始日期，作为 Carbon\Carbon 实例（默认情况下，如果不提供，则现在开始）。

更改计划

您可以轻松地按如下方式更改订阅计划

use Laravelcm\Subscriptions\Models\Plan;
use Laravelcm\Subscriptions\Models\Subscription;

$plan = Plan::find(2);
$subscription = Subscription::find(1);

// Change subscription plan
$subscription->changePlan($plan);

如果两个计划（当前计划和新的计划）具有相同的计费频率（例如，invoice_period 和 invoice_interval），则订阅将保留相同的计费日期。如果计划没有相同的计费频率，则订阅将采用新的计划计费频率，从变更当天开始，并且订阅使用数据将被清除。此外，如果新的计划有一个试用期限并且是新的订阅，则将应用试用期限。

功能选项

计划功能非常适合调整订阅，您可以充值特定功能X次使用，然后用户可能只会使用那么多。功能还具有可重置的能力，然后其使用也可能过期。请参阅以下示例

use Laravelcm\Subscriptions\Models\Feature;

// Find plan feature
$feature = Feature::where('name', 'listing_duration_days')->first();

// Get feature reset date
$feature->getResetDate(new \Carbon\Carbon());

订阅功能使用

有多种方法可以确定用户订阅中特定功能的用法和能力，最常见的是 canUseFeature

canUseFeature 方法根据多个因素返回 true 或 false

• 功能已启用。
• 功能值不是 0/false/NULL。
• 或者功能还有剩余的使用次数。

$user->planSubscription('main')->canUseFeature('listings');

用户订阅实例上的其他功能方法包括

• getFeatureUsage：返回用户使用特定功能的次数。
• getFeatureRemainings：返回特定功能的可用使用次数。
• getFeatureValue：返回功能值。

所有方法具有相同的签名：例如 $user->planSubscription('main')->getFeatureUsage('listings');。

记录功能使用

为了有效使用能力方法，您需要跟踪每个功能的每次使用（至少是那些需要它的功能）。您可以使用通过用户 subscription() 方法提供的 recordFeatureUsage 方法

$user->planSubscription('main')->recordFeatureUsage('listings');

recordFeatureUsage 方法接受3个参数：第一个是功能的名称，第二个是要添加的使用次数（默认为 1），第三个指示添加是否为增量（默认行为），当禁用时，使用次数将被提供的数量覆盖。例如

// Increment by 2
$user->planSubscription('main')->recordFeatureUsage('listings', 2);

// Override with 9
$user->planSubscription('main')->recordFeatureUsage('listings', 9, false);

减少功能使用

减少功能使用与增加它几乎相同。在这里，我们仅从实际使用次数中减去一个给定的数量（默认为 1）

$user->planSubscription('main')->reduceFeatureUsage('listings', 2);

清除订阅使用数据

$user->planSubscription('main')->usage()->delete();

检查订阅状态

要使订阅被视为活动状态，以下条件之一必须为 true

• 订阅有一个活动的试用。
• 订阅 ends_at 在未来。

$user->subscribedTo($planId);

或者您可以使用以下订阅模型中可用的方法

$user->planSubscription('main')->active();
$user->planSubscription('main')->canceled();
$user->planSubscription('main')->ended();
$user->planSubscription('main')->onTrial();

具有活动试用或 ends_at 在未来的已取消订阅被视为活动。

续订订阅

要续订订阅，您可以使用订阅模型中提供的 renew 方法。这将根据所选计划设置新的 ends_at 日期，并且将清除订阅的使用数据。

$user->planSubscription('main')->renew();

已过期的期限的已取消订阅无法续订。

取消订阅

要取消订阅，只需在用户的订阅上使用 cancel 方法

$user->planSubscription('main')->cancel();

默认情况下，订阅将保持活动状态直到期末，您可以将 true 传递以立即结束订阅

$user->planSubscription('main')->cancel(true);

作用域

订阅模型

use Laravelcm\Subscriptions\Models\Subscription;
use App\Models\User;

// Get subscriptions by plan
$subscriptions = Subscription::byPlanId($plan_id)->get();

// Get bookings of the given user
$user = User::find(1);
$bookingsOfSubscriber = Subscription::ofSubscriber($user)->get(); 

// Get subscriptions with trial ending in 3 days
$subscriptions = Subscription::findEndingTrial(3)->get();

// Get subscriptions with ended trial
$subscriptions = Subscription::findEndedTrial()->get();

// Get subscriptions with period ending in 3 days
$subscriptions = Subscription::findEndingPeriod(3)->get();

// Get subscriptions with ended period
$subscriptions = Subscription::findEndedPeriod()->get();

模型

Laravel Subscriptions 使用 4 个模型

Laravelcm\Subscriptions\Models\Plan;
Laravelcm\Subscriptions\Models\Feature;
Laravelcm\Subscriptions\Models\Subscription;
Laravelcm\Subscriptions\Models\SubscriptionUsage;

更新日志

有关项目的完整历史记录，请参阅更新日志。

支持

以下支持渠道随时可供您使用

• 在Telegram上聊天
• 通过电子邮件获得帮助
• 在Twitter上关注

贡献和协议

感谢您考虑为这个项目做出贡献！贡献指南可以在CONTRIBUTING.md中找到。

欢迎提交错误报告、功能请求和拉取请求。

• 版本控制
• 拉取请求
• 编码规范
• 功能请求
• Git流程

安全漏洞

如果您在此项目中发现安全漏洞，请发送电子邮件至 developers@laravel.cm。所有安全漏洞都将得到及时处理。

关于Laravel Cameroon

喀麦隆PHP和Laravel开发者社区，喀麦隆最大的开发者聚集地。

许可协议

本软件遵循 MIT许可协议（MIT） 发布。

（c）2018-2023 Laravel Cameroun，部分权利保留。