README

Rinvex Subscriptions 是一个灵活的计划和订阅管理系统，适用于Laravel，提供了运行您SAAS服务的必要工具。它简单的架构，配合强大的底层，为您的业务提供了坚实的基础。

考虑事项

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

安装

通过composer安装此包

composer require elsayed85/subscriptions

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

php artisan vendor:publish --tag=tenant_subscriptions-config

使用以下命令执行迁移（到迁移文件夹中的 : 文件夹）
```
php artisan elsayed85:publish-migration --to=landlord
```
完成！

使用方法

将订阅添加到用户模型中

elsayed85 Subscriptions 特别为Eloquent设计，非常注重简洁性。要将订阅功能添加到您的用户模型中，只需像这样使用 \elsayed85\Subscriptions\Traits\HasSubscriptions 特性：

namespace App\Models;

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

class User extends Authenticatable
{
    use HasSubscriptions;
}

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

创建一个计划

$plan = app('elsayed85.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('elsayed85.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('elsayed85.subscriptions.plan_feature')->where('name', 'pictures_per_listing')->first()->value;

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

创建一个订阅

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

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

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

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

更改计划

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

$plan = app('elsayed85.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('elsayed85.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('elsayed85.subscriptions.plan_subscription')->byPlanId($plan_id)->get();

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

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

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

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

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

模型

elsayed85 Subscriptions使用4个模型

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

变更日志

请参阅变更日志以获取项目的完整历史记录。

支持

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

贡献和协议

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

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

安全漏洞

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

关于Rinvex

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

许可证

本软件依据MIT许可证（MIT）发布。

elsayed85 / subscriptions

维护者

详细信息