samehdoush/subscriptions

这是我的包订阅

维护者

详细信息

github.com/samehdoush/subscriptions

主页

源代码

问题

安装: 104

依赖: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

开放问题: 1

dev-main 2024-04-14 16:29 UTC

Requires

Requires (Dev)

MIT 952c1f4b9d0e55d8fa03341f1869c254582c989d

  • sameh doush <samehdev95.woop@gmail.com>

laravelsubscriptionssamehdoush

This package is auto-updated.

Last update: 2024-09-14 17:26:50 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

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

支持我们

我们投入了大量资源来创建一流的开放式源代码包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄给我们明信片，说明您正在使用我们的哪个包。您可以在我们的联系页面上找到我们的地址。我们将所有收到的明信片发布在我们的虚拟明信片墙上。

这个想法受到了rinvex/laravel-subscriptions的启发

安装

您可以通过composer安装此包

composer require samehdoush/subscriptions

自动安装

php artisan subscriptions:install

或者

您可以使用以下命令发布并运行迁移

php artisan vendor:publish --tag="subscriptions-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="subscriptions-config"

这是已发布配置文件的内容

return [
];

可选地，您可以使用以下命令发布视图

php artisan vendor:publish --tag="subscriptions-views"

用法

$subscriptions = new Samehdoush\Subscriptions();
echo $subscriptions->echoPhrase('Hello, Samehdoush!');

用法

将订阅添加到User模型

** Subscriptions** 是专门为Eloquent设计的，简洁性被非常认真地考虑，就像其他任何与Laravel相关的方面一样。要将订阅功能添加到您的User模型，只需使用如下的\Samehdoush\Subscriptions\Traits\HasPlanSubscriptions trait

namespace App\Models;

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

class User extends Authenticatable
{
    use HasPlanSubscriptions;
}

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

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

创建一个计划

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

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

创建一个订阅

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

$user = User::find(1);
$plan = \Samehdoush\Subscriptions\Models\Plan::find(1);

$user->newPlanSubscription('main', $plan);
$user->newPlanSubscriptionWithOutTrail('main', $plan); // without trial

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

更改计划

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

$plan = \Samehdoush\Subscriptions\Models\Plan::find(2);
$subscription = \Samehdoush\Subscriptions\Models\PlanSubscription::find(1);

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

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

功能选项

计划功能非常适合微调订阅，您可以对某些功能进行X次使用充值，这样用户就只能使用这么多的量。功能还具有可重置的功能，然后其使用也可能到期。请参阅以下示例

// Find plan feature
$feature = \Samehdoush\Subscriptions\Models\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：返回特定功能的可用使用次数。
  • getFeatureRemainingsOrText ：返回特定功能的可用使用次数，但如果返回 -1，则表示无限。
  • 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 = \Samehdoush\Subscriptions\Models\PlanSubscription::byPlanId($plan_id)->get();

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

// Get subscriptions with trial ending in 3 days
$subscriptions = \Samehdoush\Subscriptions\Models\PlanSubscription::findEndingTrial(3)->get();

// Get subscriptions with ended trial
$subscriptions = \Samehdoush\Subscriptions\Models\PlanSubscription::findEndedTrial()->get();

// Get subscriptions with period ending in 3 days
$subscriptions = \Samehdoush\Subscriptions\Models\PlanSubscription::findEndingPeriod(3)->get();

// Get subscriptions with ended period
$subscriptions = \Samehdoush\Subscriptions\Models\PlanSubscription::findEndedPeriod()->get();

模型

** 订阅** 使用4个模型

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

测试

composer test

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全漏洞

请审查我们的安全策略，了解如何报告安全漏洞。

致谢

许可证

MIT 许可证（MIT）。有关更多信息，请参阅许可证文件。