README

Laravel 的用户关注/取消关注行为。

介绍

允许人们表达他们对模型（文档/主题/话题）的感受。

安装

要求

• PHP 8.0+
• Composer
• Laravel 8.0+

说明

使用 Composer 安装 Laravel Follow。

composer require laravel-interaction/follow

发布配置和迁移

php artisan vendor:publish --tag=follow-config
php artisan vendor:publish --tag=follow-migrations

运行数据库迁移。

php artisan migrate

用法

设置关注者

use Illuminate\Database\Eloquent\Model;
use LaravelInteraction\Follow\Concerns\Follower;

class User extends Model
{
    use Follower;
}

设置可关注对象

use Illuminate\Database\Eloquent\Model;
use LaravelInteraction\Follow\Concerns\Followable;

class Channel extends Model
{
    use Followable;
}

关注者

use LaravelInteraction\Follow\Tests\Models\Channel;
/** @var \LaravelInteraction\Follow\Tests\Models\User $user */
/** @var \LaravelInteraction\Follow\Tests\Models\Channel $channel */
// Follow to Followable
$user->follow($channel);
$user->unfollow($channel);
$user->toggleFollow($channel);

// Compare Followable
$user->hasFollowed($channel);
$user->hasNotFollowed($channel);

// Get followed info
$user->followerFollowings()->count(); 

// with type
$user->followerFollowings()->withType(Channel::class)->count(); 

// get followed channels
Channel::query()->whereFollowedBy($user)->get();

// get followed channels doesnt followed
Channel::query()->whereNotFollowedBy($user)->get();

可关注对象

use LaravelInteraction\Follow\Tests\Models\User;
use LaravelInteraction\Follow\Tests\Models\Channel;
/** @var \LaravelInteraction\Follow\Tests\Models\User $user */
/** @var \LaravelInteraction\Follow\Tests\Models\Channel $channel */
// Compare Follower
$channel->isFollowedBy($user); 
$channel->isNotFollowedBy($user);
// Get followers info
$channel->followers->each(function (User $user){
    echo $user->getKey();
});

$channels = Channel::query()->withCount('followers')->get();
$channels->each(function (Channel $channel){
    echo $channel->followers()->count(); // 1100
    echo $channel->followers_count; // "1100"
    echo $channel->followersCount(); // 1100
    echo $channel->followersCountForHumans(); // "1.1K"
});

事件

许可证

Laravel Follow 是一个开源软件，根据 MIT 许可证 授权。