README

⚠️ 此包是 rinvex/laravel-subsscription 包的更新版本，我只是让它与 Laravel 8 和 Laravel 9 兼容 ⚠️

注意： 这不是它的替代品。只是针对那些试图在 Laravel 8 和 Laravel 9 上运行它的人。

BprooDev Subscriptions 是一个灵活的计划和订阅管理系统，适用于 Laravel，提供了运行您的 SAAS 服务的必要工具，以高效地运行。它具有简单的架构，并辅以强大的底层支持，为您的企业提供坚实的平台。

注意事项

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

关于 Laravel v9 的说明

此包需要 rinvex/laravel-support，它还要求 felixkiss/uniquewith-validator 依赖项，该依赖项尚与 Laravel v9 不兼容！但是作为一个临时的解决方案，将 Laravel Shift 的分支添加到项目根目录 composer.json 的 repositories 属性中。

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/laravel-shift/uniquewith-validator.git"
        }
    ]
}

安装

通过 composer 安装此包

composer require bproodev/laravel-subscriptions

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

php artisan bproodev:publish:subscriptions

通过以下命令执行迁移

php artisan bproodev:migrate:subscriptions

完成！

用法

将订阅添加到 User 模型中

BprooDev Subscriptions 是专门为 Eloquent 和简洁性而制作的，简洁性在其他任何 Laravel 相关方面都得到了高度重视。要将订阅功能添加到您的 User 模型中，只需像这样使用 \BprooDev\Subscriptions\Traits\HasPlanSubscriptions trait：

namespace App\Models;

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

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

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

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

创建计划

$plan = app('bproodev.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('bproodev.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();

both $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('bproodev.subscriptions.plan_feature')->where('slug', 'pictures_per_listing')->first()->value;

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

创建订阅

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

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

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

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

更改计划

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

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

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

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

功能选项

计划功能非常适合微调订阅，您可以充值某些功能以供 X 次使用，因此用户可以使用其仅为此数量。功能还具有可重置的能力，因此其使用也可能过期。请参见以下示例

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

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

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

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

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

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

模型

bproodev 订阅使用4种模型

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

路线图

寻找贡献者！

以下是需要改进的局限性集合，或寻找贡献者实施的功能请求，所有PR都欢迎 😊

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

变更日志

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

支持

以下支持渠道尽在您的指尖

贡献与协议

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

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

安全漏洞

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

关于BprooDev

BprooDev是一个主要的教育计划，旨在通过其导师平台和高质量的内容，以非常实惠的价格将更多非洲人带入技术领域。我们将您从入门或中级水平带到专业水平。

许可

此软件根据MIT许可（MIT）发布。

bproodev / subscriptions

维护者

详细信息