README

TheArtizan Laravel Subscriptions (Forked Rinvex Laravel Subscriptions) 是一个灵活的计划和订阅管理系统，适用于 Laravel，提供运行 SAAS 类服务所需的所有工具，以高效地运行您的服务。其简单架构，辅以强大的底层技术，为您的业务提供坚实的平台。

注意事项

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

安装

1. 通过 composer 安装此包

   composer require theartizan/subscriptions:dev-master

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

   php artisan theartizan:publish:subscriptions

3. 执行以下命令以运行迁移

   php artisan theartizan:migrate:subscriptions

4. 完成！

用法

将 Subscriptions 添加到 User 模型

TheArtizan Subscriptions 是专门为 Eloquent 设计的，并且非常重视简洁性。要将订阅功能添加到您的 User 模型，只需使用如下 \TheArtizan\Subscriptions\Traits\HasPlanSubscriptions 特性

namespace App\Models;

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

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

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

注意：您可以在任何订阅者模型上使用 HasPlanSubscriptions 特性，而不仅限于用户模型，实际上任何模型都可以。

创建计划

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

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

创建订阅

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

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

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

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

更改计划

您可以轻松更改订阅计划，如下所示

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

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

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

功能选项

计划功能非常适合微调订阅，您可以对某些功能进行X次使用充值，因此用户可能只使用这么多。功能还可以被重置，然后其使用也可能过期。以下是一些示例

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

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

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

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

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

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

模型

TheArtizan 订阅使用4个模型

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

许可

此软件根据MIT 许可证 (MIT)发布。

(c) 2024 TheArtizan Studio ，保留某些权利。