README

MaxAl Subscriptions 是一个灵活的计划和订阅管理系统，适用于 Laravel，提供了运行您像 SAAS 服务一样的服务所需的所有工具。它简单的架构，伴随着强大的底层技术，为您提供一个稳固的平台。

注意事项

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

安装

1. 通过 composer 安装此包

   composer require maxal/laravel-subscriptions

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

   php artisan maxal:publish:subscriptions

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

   php artisan maxal:migrate:subscriptions

4. 完成！

使用方法

将订阅添加到 User 模型

MaxAl Subscriptions 特别为 Eloquent 设计，并将简洁性视为任何其他 Laravel 相关方面一样重要。要将订阅功能添加到您的 User 模型，只需像这样使用 \MaxAl\Subscriptions\Traits\HasPlanSubscriptions 特性：

namespace App\Models;

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

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

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

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

注意：在添加 HasPlanSubscriptions 特性后，请将以下内容添加到模型中：

namespace App\Models;

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

class User extends Authenticatable
{
    use HasPlanSubscriptions;

     public function morphMany($related, $name, $type = null, $id = null, $localKey = null)
    {
        return parent::morphMany($related, $name, $type = null, $id = null, $localKey = null);
    }
}

创建一个计划

$plan = app('maxal.subscriptions.plan')->create([
    'name' => 'Pro',
    'description' => 'Pro plan',
    'incentive_text' => '-10 %',
    '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('maxal.subscriptions.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 the plan instance to get feature's value
$amountOfPictures = $plan->getFeatureBySlug('pictures_per_listing')->value;

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

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

创建订阅

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

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

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

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

更改计划

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

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

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

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

功能选项

计划功能非常适合微调订阅，您可以为X次使用次数预付费，这样用户就只能使用这么多。功能还可以被重置，然后它的使用也可能过期。请参见以下示例

// Find plan feature
$feature = app('maxal.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->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')->usages()->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);

作用域

订阅模型

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

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

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

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

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

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

模型

MaxAl 订阅使用4个模型

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

路线图

寻找贡献者！

以下是一系列待改进的限制，或寻找贡献者实现的功能请求，所有PR都欢迎 🙂

• 允许为同一计划的多次发生支付（即月度计划，用户可以为该计划支付6个月的费用）（#64）
• 数据库中计划的prorate字段未使用，这应该实现以合并扩展日期和价格（#68）
• 将功能改为与计划的多对多关系。多个计划可以具有相同的功能，多个计划也可以具有许多功能。（#101）
• 数据库中的计划订阅时区字段未使用，应实现以尊重日期计算（例如 starts_at、ends_at、trial_ends_at）的时区 (#78)
• 将试用功能从订阅周期中分离出来，并相应调整订阅。用户应该能够在没有订阅的情况下拥有试用周期 (#67)

变更日志

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

支持

以下支持渠道触手可及

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

贡献 & 协议

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

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

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

安全漏洞

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

关于MaxAl

MaxAl是一家专注于集成企业解决方案的软件开发初创公司，自2018年3月成立以来一直致力于在阿尔巴尼亚的提拉那设计和支持IT。我们相信，我们的驱动力——价值、影响力和影响力是我们区别于其他公司的关键，并通过软件的力量释放我们哲学的无限可能性。我们喜欢称之为“生活速度的创新”。这就是我们为推进人类进步所做的一份贡献。

许可协议

本软件根据MIT许可协议（MIT）发布。

(c) 2018-2022 MaxAl，部分权利保留。