Laravel Follow

User follow/unfollow behaviour for Laravel.

Introduction

It let people express how they feel about the model(documentation/subject/topic).

Installation

Requirements

• PHP 8.0+
• Composer
• Laravel 8.0+

Instructions

Require Laravel Follow using Composer.

composer require laravel-interaction/follow

Publish configuration and migrations

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

Run database migrations.

php artisan migrate

Usage

Setup Follower

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

class User extends Model
{
    use Follower;
}

Setup Followable

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

class Channel extends Model
{
    use Followable;
}

Follower

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();

Followable

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"
});

Events

| Event | Fired | | --- | --- | | LaravelInteraction\Follow\Events\Followed | When an object get followed. | | LaravelInteraction\Follow\Events\Unfollowed | When an object get unfollowed. |

License

Laravel Follow is an open-sourced software licensed under the MIT license.