temian/referral-system

dev-main 2024-06-05 15:04 UTC

This package is auto-updated.

Last update: 2024-09-05 15:27:18 UTC


README

Heading of Laravel Referral

Latest Version on Packagist Total Downloads License

"jijunair/laravel-referral"包是一个自定义的Laravel包,为您的Laravel应用程序提供推广代码功能。它允许您生成推广代码,将它们与用户关联,根据推广代码检索用户,以及其他所有相关功能。

安装

您可以通过运行以下命令使用Composer安装此包:

composer require temian/referral-system

配置

该包提供了一个配置文件,允许您自定义其行为。您应该使用以下命令发布迁移和config/referral.php配置文件:

php artisan vendor:publish --provider="Jijunair\LaravelReferral\Providers\ReferralServiceProvider"

发布后,您可以在config/referral.php中找到配置文件。

这些配置选项有助于自定义Laravel应用程序中推广系统的行为。请根据您的喜好和要求调整这些值!

迁移

配置和迁移发布并配置后,您可以通过运行以下命令创建此包的表:

 php artisan migrate

添加特质

将必要的特质添加到您的User模型中

use Jijunair\LaravelReferral\Traits\Referrable;

class User extends Model
{
    use Referrable;
}

用法

为现有用户生成推广账户

要为现有用户生成推广账户,您可以访问以下URL:

https://:8000/generate-ref-accounts

这将为您应用程序中的所有现有用户生成推广代码。

获取用户的推广者

要获取用户的推广者,您可以使用以下代码:

use Illuminate\Support\Facades\Auth;

$user = Auth::user();
$referrer = $user->referralAccount->referrer;

这将检索与用户关联的推广者。

通过推广代码获取推广者

要通过对推广代码获取推广者,您可以使用以下代码:

use Jijunair\LaravelReferral\Models\Referral;
use Illuminate\Support\Facades\Cookie;

$referralCode = Cookie::get(config('referral.cookie_name'));
$referrer = Referral::userByReferralCode($referralCode);

这将根据存储在cookie中的推广代码检索推广者。

检查用户是否有推广账户

要检查用户是否有推广账户,您可以使用以下代码:

$user->hasReferralAccount();

如果用户有推广账户,则返回true,否则返回false

为用户创建推广账户

要为用户创建推广账户,您可以使用以下代码:

$user->createReferralAccount($referrer->id);

这将通过创建推广账户将用户与提供的推广者关联。

获取用户的全部推广

要获取用户下的全部推广,您可以使用以下代码:

$referrals = $user->referrals;

这将检索与用户关联的所有推广。

获取用户的推广链接

要获取用户的推广链接,您可以使用以下代码:

$referralLink = $user->getReferralLink();

这将返回与用户关联的推广链接。

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

感谢您考虑为Laravel推广包做出贡献!如果您有任何建议、错误报告或拉取请求,请随时在GitHub存储库中打开一个问题或提交一个拉取请求。

许可

Laravel推广包是开源软件,许可协议为MIT