README

⚠️ 此包是从一个已废弃且不再维护的包中分叉而来。未建议替代包。⚠️

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

注意事项

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

安装

使用 composer 安装此包

composer require cryptodev4/laravel-subscriptions

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

php artisan cryptodev4:publish:subscriptions

通过以下命令执行迁移

php artisan cryptodev4:migrate:subscriptions

完成！

使用方法

将订阅添加到用户模型

Laravel Subscriptions 专为 Eloquent 设计，非常注重简洁性。要将订阅功能添加到您的用户模型中，只需使用 \CryptoDev4\LaravelSubscriptions\Traits\HasPlanSubscriptions 特性，如下所示

namespace App\Models;

use CryptoDev4\LaravelSubscriptions\Traits\HasPlanSubscriptions;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

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

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

创建一个计划

$plan = 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 = 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 = PlanFeature::where('slug', 'pictures_per_listing')->first()->value;

// Get feature value through the subscription instance
$amountOfPictures = PlanSubscription::find(1)->getFeatureValue('pictures_per_listing');

创建一个订阅

您可以使用 HasPlanSubscriptions 特性中提供的 newSubscription() 函数来让用户订阅计划。首先，获取您的订阅者模型实例，这通常是您的用户模型，以及用户要订阅的计划实例。一旦获取了模型实例，您就可以使用 newSubscription 方法创建模型的订阅。

$user = User::find(1);
$plan = Plan::find(1);

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

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

更改计划

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

$plan = Plan::find(2);
$subscription = PlanSubscription::find(1);

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

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

功能选项

计划功能非常适合微调订阅，您可以为特定功能充值X次使用，因此用户可能只需使用这么多。功能还具有可重置的能力，然后其使用可能会过期。请参见以下示例

// Find plan feature
$feature = PlanFeature::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 = PlanSubcription::byPlanId($plan_id)->get();

// Get bookings of the given user
$user = \App\Models\User::find(1);
$bookingsOfSubscriber = PlanSubcription::ofSubscriber($user)->get(); 

// Get subscriptions with trial ending in 3 days
$subscriptions = PlanSubcription::findEndingTrial(3)->get();

// Get subscriptions with ended trial
$subscriptions = PlanSubcription::findEndedTrial()->get();

// Get subscriptions with period ending in 3 days
$subscriptions = PlanSubcription::findEndingPeriod(3)->get();

// Get subscriptions with ended period
$subscriptions = PlanSubcription::findEndedPeriod()->get();

模型

CryptoDev4 订阅 使用 4 个模型

CryptoDev4\LaravelSubscriptions\Models\Plan;
CryptoDev4\LaravelSubscriptions\Models\PlanFeature;
CryptoDev4\LaravelSubscriptions\Models\PlanSubscription;
CryptoDev4\LaravelSubscriptions\Models\PlanSubscriptionUsage;

路线图

寻找贡献者！

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

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

变更日志

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

支持

以下支持渠道尽在指尖

贡献与协议

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

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

安全漏洞

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

关于CryptoDev4

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

许可证

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

cryptodev4 / laravel-subscriptions

维护者

详细信息