Stars: 1098
Forks: 139
Pull Requests: 76
Issues: 119
Watchers: 26
Last Updated: 2023-07-02 02:36:49
:heart: This package helps you to add user based follow system to your model.
License: MIT License
Languages: PHP
User follow unfollow system for Laravel.
Related projects:
composer require overtrue/laravel-follow -vvv
php artisan vendor:publish --provider="Overtrue\LaravelFollow\FollowServiceProvider"
Overtrue\LaravelFollow\Traits\Follower
Add the Follower trait to your user model:
use Overtrue\LaravelFollow\Traits\Follower;
class User extends Authenticatable
{
use Follower;
<...>
}
Overtrue\LaravelFollow\Traits\Followable
Then add the Followable trait to your followable model, for example App\User
:
use Overtrue\LaravelFollow\Traits\Followable;
class User extends Authenticatable
{
use Followable;
<...>
}
or any other model:
use Overtrue\LaravelFollow\Traits\Followable;
class Channel extends Model
{
use Followable;
<...>
}
$user1 = User::find(1);
$user2 = User::find(2);
$user1->follow($user2);
$user1->unfollow($user2);
$user1->toggleFollow($user2);
$user1->acceptFollowRequestFrom($user2);
$user1->rejectFollowRequestFrom($user2);
$user1->isFollowing($user2);
$user2->isFollowedBy($user1);
$user2->hasRequestedToFollow($user1);
$user->followings;
$user->approvedFollowings;
$user->notApprovedFollowings;
foreach($user->followings()->with('followable')->get() as $following)
{
$following->created_at; // followed at
$following->followable->nickname; // the user attributes
}
$user->followers;
$user->approvedFollowers;
$user->notApprovedFollowers;
foreach($user->followers()->with('followers')->get() as $follower)
{
$follower->created_at; // followed at
$follower->follower->nickname; // the user attributes
}
If you would like to have some follow requests to need to be accepted by the user being followed, simply override the needsToApproveFollowRequests() method in the model that uses the Followable trait with your custom logic:
public function needsToApproveFollowRequests()
{
// Your custom logic here
return (bool) $this->private;
}
// followings count
$user->followings()->count();
$user->approvedFollowings()->count();
$user->notApprovedFollowings()->count();
// with query where
$user->followings()->where('gender', 'female')->count();
// followers count
$user->followers()->count();
$user->approvedFollowers()->count();
$user->notApprovedFollowers()->count();
List with *_count
attribute:
$users = User::withCount(['followings', 'followables'])->get();
// or
$users = User::withCount(['approvedFollowings', 'approvedFollowers'])->get();
foreach($users as $user) {
// $user->followings_count;
// $user->followers_count;
// or
// $user->approved_followings_count;
// $user->approved_followers_count;
}
You can use Follower::attachFollowStatus(Collection $followables)
to attach the user follow status, it will set has_followed
attribute to each model of $followables
:
$user1 = User::find(1);
$user->attachFollowStatus($user1);
// result
[
"id" => 1
"name" => "user1"
"private" => false
"created_at" => "2021-06-07T15:06:47.000000Z"
"updated_at" => "2021-06-07T15:06:47.000000Z"
"has_followed" => true
]
Collection | Paginator | LengthAwarePaginator | array
:$user = auth()->user();
$users = User::oldest('id')->get();
$users = $user->attachFollowStatus($users);
$users = $users->toArray();
// result
[
[
"id" => 1
"name" => "user1"
"private" => false
"created_at" => "2021-06-07T15:06:47.000000Z"
"updated_at" => "2021-06-07T15:06:47.000000Z"
"has_followed" => true
],
[
"id" => 2
"name" => "user2"
"private" => false
"created_at" => "2021-06-07T15:06:47.000000Z"
"updated_at" => "2021-06-07T15:06:47.000000Z"
"has_followed" => true
],
[
"id" => 3
"name" => "user3"
"private" => false
"created_at" => "2021-06-07T15:06:47.000000Z"
"updated_at" => "2021-06-07T15:06:47.000000Z"
"has_followed" => false
],
[
"id" => 4
"name" => "user4"
"private" => false
"created_at" => "2021-06-07T15:06:47.000000Z"
"updated_at" => "2021-06-07T15:06:47.000000Z"
"has_followed" => false
],
]
$users = User::paginate(20);
$user->attachFollowStatus($users);
You can query users order by followers count with following methods:
orderByFollowersCountDesc()
orderByFollowersCountAsc()
orderByFollowersCount(string $direction = 'desc')
example:
$users = User::orderByFollowersCountDesc()->get();
$mostPopularUser = User::orderByFollowersCountDesc()->first();
To avoid the N+1 issue, you can use eager loading to reduce this operation to just 2 queries. When querying, you may specify which relationships should be eager loaded using the with
method:
$users = User::with('followings')->get();
foreach($users as $user) {
$user->isFollowing(2);
}
$users = User::with('followables')->get();
foreach($users as $user) {
$user->isFollowedBy(2);
}
Event | Description |
---|---|
Overtrue\LaravelFollow\Events\Followed |
Triggered when the relationship is created. |
Overtrue\LaravelFollow\Events\Unfollowed |
Triggered when the relationship is deleted. |
如果你喜欢我的项目并想支持它,点击这里 ❤️
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
You can contribute in one of three ways:
The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.
想知道如何从零开始构建 PHP 扩展包?
请关注我的实战课程,我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》
MIT