kayw-geek/yii2-follow

This package helps you to add user based follow system to your model.

V1.0 2020-09-17 09:43 UTC

Requires

• yiisoft/yii2: *

MIT

• Kay W

• yii
• yii2
• Follow
• fans
• yii2-model

README

User follow unfollow system for Yii2.

Installing

$ composer require kayw-geek/yii2-follow

Migrations

This step is also optional, if you want to custom the pivot table, you can publish the migration files:

$ yii migrate/up --migrationPath=@vendor/kayw-geek/yii2-follow/migrations

Usage

Traits

kaywGeek\Follow\FollowerTrait

use kaywGeek\follow\FollowerTrait;
use Yii;
use yii\base\NotSupportedException;
use yii\behaviors\TimestampBehavior;
use yii\db\ActiveRecord;
use yii\web\IdentityInterface;

class User extends ActiveRecord implements IdentityInterface
{
    <...>
    use FollowerTrait;
    <...>
}

API

$user1 = User::findOne(1);
$user2 = User::findOne(2);

$user1->follow($user2);
$user1->unfollow($user2);
$user1->checkFollowed($user2);
$user1->followedCount();
$user1->followerCount();

Get followings:

$user->followings;

Get followers:

$user->followers;

Aggregations

// with query where
$user->followings()->where(['<',['follow_at'=>date('Y-m-d')]])->all();

// followers orderBy
$user->followers()->orderBy('follow_at desc');

License