README

Rinvex Subscriptions 是 Laravel 的一个灵活的计划和订阅管理系统，提供了运行您的 SAAS 服务的所需工具，以高效地运行。它的简单架构，伴随着强大的底层支持，为您的业务提供稳固的平台。

考虑事项

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

安装

通过 composer 安装此包

composer require rinvex/laravel-subscriptions

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

php artisan rinvex:publish:subscriptions

通过以下命令执行迁移

php artisan rinvex:migrate:subscriptions

完成！

用法

将订阅添加到用户模型

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

namespace App\Models;

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

class User extends Authenticatable
{
    use HasSubscriptions;
}

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

创建一个计划

$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();

Both $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方法接受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('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;

变更日志

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

支持

以下支持渠道触手可及

贡献 & 协议

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

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

安全漏洞

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

关于Rinvex

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

许可证

本软件基于MIT 许可证 (MIT)发布。

rymesaint / laravel-subscriptions

维护者

详细信息