README

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

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

安装

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

composer require sapere/laravel-referral

配置

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

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

发布后，您可以在 config/referral.php 找到配置文件。此文件允许您配置 Cookie 名称和其他特定于包的设置。

迁移

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

 php artisan migrate

添加特性

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

use sapere\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 sapere\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 许可证的许可。

了解 / laravel-referral

维护者

详细信息