README

Rinvex Subscriptions 是一个灵活的计划和订阅管理系统，适用于 Laravel，具有运行类似 SAAS 服务的所需工具，能够高效地运行。它的简单架构，伴随着强大的底层技术，为您的业务提供了一个坚实的平台。

⚠️ 此包已被重命名，现在在 rinvex/laravel-subscriptions 维护，作者建议使用新包。旧包支持 Laravel v5.6，而新包支持 Laravel v5.7+。

考虑事项

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

安装

1. 通过 composer 安装此包

   composer require rinvex/subscriptions

2. 执行以下命令进行迁移

   php artisan rinvex:migrate:subscriptions

3. 完成！

使用方法

将订阅添加到 User 模型

Rinvex Subscriptions 是专门为 Eloquent 和简洁性而设计的，在这方面与任何其他 Laravel 相关方面一样，都高度重视简洁性。要将订阅功能添加到您的 User 模型中，只需使用 \Rinvex\Subscriptions\Traits\HasSubscriptions trait，如下所示

namespace App\Models;

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

class User extends Authenticatable
{
    use HasSubscriptions;
}

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

创建计划

$plan = app('rinvex.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('rinvex.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->getFeatureByName('pictures_per_listing')->value;

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

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

创建订阅

您可以使用在HasSubscriptions特性中可用的newSubscription()函数将用户订阅到计划。首先，获取您的订阅者模型实例，这通常将是您的用户模型以及用户要订阅的计划实例。一旦获取了模型实例，您就可以使用newSubscription方法来创建模型的订阅。

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

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

newSubscription方法传入的第一个参数应该是订阅的标题。如果您的应用程序提供单个订阅，您可能将其称为main或primary。第二个参数是用户订阅的计划实例。

更改计划

您可以通过以下方式轻松更改订阅计划：

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

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

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

功能选项

计划功能非常适合微调订阅，您可以增加特定功能的X次使用次数，这样用户就只能使用这么多。功能还具有可重置的功能，其使用也可以过期。请参阅以下示例

// Find plan feature
$feature = app('rinvex.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方法接受三个参数：第一个是功能的名称，第二个是要添加的使用次数（默认为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('rinvex.subscriptions.plan_subscription')->byPlanId($plan_id)->get();

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

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

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

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

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

模型

Rinvex Subscriptions 使用 4 种模型：

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

更新日志

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

支持

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

• 在 Slack 上聊天
• 通过电子邮件寻求帮助
• 在 Twitter 上关注

贡献 & 协议

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

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

• 版本控制
• 拉取请求
• 编码标准
• 功能请求
• Git Flow

安全漏洞

如果您在这个项目中发现了安全漏洞，请发送电子邮件至help@rinvex.com。所有安全漏洞都将得到及时处理。

关于 Rinvex

Rinvex 是一家成立于埃及亚历山大，自 2016 年 6 月以来专门为中小企业提供集成企业解决方案的软件解决方案初创公司。我们相信，我们的动力在于“价值、影响力和影响力”，这是我们与众不同的地方，并通过软件的力量释放我们哲学的无限可能性。我们喜欢称之为“以生活速度的创新”。这就是我们为推动人类进步做出贡献的方式。

许可证

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

(c) 2016-2018 Rinvex LLC，保留部分权利。