README

Diviky Subscriptions 是为 Laravel 设计的灵活的计划和订阅管理系统，提供了运行 SAAS 类服务的必要工具，以高效地运行。其简单架构，结合强大的底层支持，为您的业务提供了坚实的平台。

注意事项

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

安装

1. 通过 composer 安装包

   composer require diviky/laravel-subscriptions

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

   php artisan diviky:publish:subscriptions

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

   php artisan diviky:migrate:subscriptions

4. 完成！

用法

将订阅添加到 User 模型

Diviky Subscriptions 特别为 Eloquent 设计，非常重视简洁性。要将订阅功能添加到您的 User 模型，只需使用以下 \Diviky\Subscriptions\Concerns\HasPlanSubscriptions 特性

namespace App\Models;

use Diviky\Subscriptions\Concerns\HasPlanSubscriptions;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

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

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

创建一个计划

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

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

创建一个订阅

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

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

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

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

更改计划

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

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

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

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

功能选项

计划功能非常适合精细调整订阅，您可以多次使用某些功能，用户可能仅使用这些功能。功能还可以重置，其使用可能也会到期。以下是一些示例

// Find plan feature
$feature = app('diviky.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')->usage()->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('diviky.subscriptions.plan_subscription')->byPlanId($plan_id)->get();

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

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

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

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

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

模型

Diviky 订阅 使用 4 个模型

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

路线图

寻找贡献者！

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

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

更新日志

请参考项目的完整历史记录变更日志。

支持

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

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

贡献 & 协议

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

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

• 版本管理
• 拉取请求
• 编码规范
• 功能请求
• Git Flow

安全漏洞

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

关于Diviky

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

许可证

本软件在MIT许可证（MIT）下发布。

© 2016-2022 Diviky LLC，部分权利保留。