README

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

安装
用法
变更日志
贡献
许可证

安装

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

composer require towoju5/laravel-referral

配置

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

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

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

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

迁移

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

 php artisan migrate

添加特质

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

use towoju5\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 towoju5\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();

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

变更日志

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

贡献

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

许可证

Laravel 推荐包是开源软件，采用 MIT 许可证。

towoju5 / laravel-referral

维护者

详细信息