README

PHP Subscriptions 是一个灵活的计划和订阅管理系统，适用于 Laravel，提供了运行您 SAAS 类服务的必要工具，能够高效地管理。其简单架构和强大的底层支持为您的业务提供了坚实的平台。

注意事项

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

安装

1. 使用 composer 安装此包

   composer require stephencoduor/subscriptions

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

   php artisan stephencoduor:publish:subscriptions

3. 通过以下命令执行迁移

   php artisan stephencoduor:migrate:subscriptions

4. 完成！

用法

将订阅添加到用户模型中

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

namespace App\Models;

use Stephencoduor\Subscriptions\Traits\HasSubscriptions;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasSubscriptions;
}

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

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

创建计划

$plan = app('Stephencoduor.subscriptions.plan')->create([
    'name' => 'Pro',
    'description' => 'Pro plan',
    'price' => 9.99,
    'signup_fee' => 1.99,
    'invoice_period' => 1,
    'invoice_interval' => 'month',
    'trial_period' => 15,
    'trial_interval' => 'day',
    'sort_order' => 1,
    'currency' => 'USD',
]);

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

获取计划详情

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

$plan = app('stephencoduor.subscriptions.plan')->find(1);

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

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

// 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->subscriptions 都是集合，由关系驱动，因此您可以像查询任何正常的 Eloquent 关系一样查询这些关系。例如：$plan->features()->where('name', 'listing_title_bold')->first()。

获取功能值

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

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

// Query the feature itself directly
$amountOfPictures = app('Stephencoduor.subscriptions.plan_feature')->where('slug', 'pictures_per_listing')->first()->value;

// Get feature value through the subscription instance
$amountOfPictures = app('Stephencoduor.subscriptions.plan_subscription')->find(1)->getFeatureValue('pictures_per_listing');

创建订阅

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

$user = User::find(1);
$plan = app('stephencoduorStephencoduor.subscriptions.plan')->find(1);

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

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

更改计划

您可以轻松更改订阅计划，如下所示

$plan = app('stephencoduor.subscriptions.plan')->find(2);
$subscription = app('stephencoduor.subscriptions.plan_subscription')->find(1);

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

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

功能选项

计划功能非常适合微调订阅，您可以多次使用某些功能，因此用户可能只会使用这么多。功能还具有可重置的能力，其使用期限也可能过期。以下是一些示例

// Find plan feature
$feature = app('stephencoduor.subscriptions.plan_feature')->where('name', 'listing_duration_days')->first();

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

订阅功能使用

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

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

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

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

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

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

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

记录功能使用情况

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

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

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

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

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

减少功能使用

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

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

清除订阅使用数据

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

检查订阅状态

要使订阅被视为活跃的，以下必须有一个 为 true

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

$user->subscribedTo($planId);

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

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

已取消的订阅，如果试用或 ends_at 在未来，则被视为活跃。

续订订阅

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

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

已取消且周期已结束的订阅无法续订。

取消订阅

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

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

默认情况下，订阅将保持活跃直到周期结束，您可以通过传递 true 立即结束订阅。

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

作用域

订阅模型

// Get subscriptions by plan
$subscriptions = app('stephencoduor.subscriptions.plan_subscription')->byPlanId($plan_id)->get();

// Get bookings of the given user
$user = \App\Models\User::find(1);
$bookingsOfSubscriber = app('stephencoduor.subscriptions.plan_subscription')->ofSubscriber($user)->get(); 

// Get subscriptions with trial ending in 3 days
$subscriptions = app('stephencoduor.subscriptions.plan_subscription')->findEndingTrial(3)->get();

// Get subscriptions with ended trial
$subscriptions = app('stephencoduor.subscriptions.plan_subscription')->findEndedTrial()->get();

// Get subscriptions with period ending in 3 days
$subscriptions = app('stephencoduor.subscriptions.plan_subscription')->findEndingPeriod(3)->get();

// Get subscriptions with ended period
$subscriptions = app('stephencoduor.subscriptions.plan_subscription')->findEndedPeriod()->get();

模型

Stephencoduor Subscriptions 使用 4 个模型

Stephencoduor\Subscriptions\Models\Plan;
Stephencoduor\Subscriptions\Models\PlanFeature;
Stephencoduor\Subscriptions\Models\PlanSubscription;
Stephencoduor\Subscriptions\Models\PlanSubscriptionUsage;

变更日志

支持

以下支持渠道随时可用

贡献 & 协议

感谢您考虑为该项目做出贡献！错误报告、功能请求和拉取请求都非常欢迎。

安全漏洞

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

许可证

本软件根据 MIT 许可证 (MIT) 发布。

(c) 2020-2021 Subscription LLC，部分权利保留。