User.php

<?php

namespace Conduit\Models;

use Illuminate\Database\Eloquent\Model;

/**
 * @property integer                                  id
 * @property string                                   email
 * @property string                                   username
 * @property string                                   image
 * @property string                                   bio
 * @property string                                   token
 * @property string                                   password
 * @property \Carbon\Carbon                           created_at
 * @property \Carbon\Carbon                           update_at
 * @property \Illuminate\Database\Eloquent\Collection followings Users who are followed by this user
 */
class User extends Model
{

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'username',
        'email',
        'password',
        'token',
        'image',
        'bio',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password',
    ];

    /**
     * Return Default Image Profile When User Does Not Have An Image
     *
     * @param $value
     *
     * @return string
     */
    public function getImageAttribute($value)
    {
        if (is_null($value)) {
            return 'https://static.productionready.io/images/smiley-cyrus.jpg';
        }

        return $value;
    }


    /********************
     *  Relationships
     ********************/

    public function comments()
    {
        return $this->hasMany(Comment::class);
    }

    public function favoriteArticles()
    {
        return $this->belongsToMany(Article::class, 'user_favorite');
    }

    /**
     * Create Many-To-Many following relationship
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function followings()
    {
        return $this->belongsToMany(
            User::class,
            'users_following',
            'user_id',
            'following_user_id')
            ->withTimestamps();
    }

    /**
     * Create following relationship. This user will follow the user with the provided id
     *
     * @param $id
     *
     * @return self
     */
    public function follow($id)
    {
        $this->followings()->syncWithoutDetaching([$id]);

        return $this;
    }

    /**
     * Remove following relationship. This user will unfollow the user with the provided id
     *
     * @param $id
     *
     * @return self
     */
    public function unFollow($id)
    {
        $this->followings()->detach($id);

        return $this;
    }

    /**
     * Check if this user is following the user with the provided id
     *
     * @param $id
     *
     * @return bool|\Conduit\Models\User
     */
    public function isFollowing($id = null)
    {
        if (is_null($id)) {
            return false;
        }

        if ($id instanceof self) {
            $id = $id->id;
        }

        return $this->newBaseQueryBuilder()
            ->from('users_following')
            ->where('user_id', $this->id)
            ->where('following_user_id', $id)
            ->exists();
    }

    /**
     * Check if this user is followed by the user with the provided id
     *
     * @param $id
     *
     * @return bool|\Conduit\Models\User
     */
    public function isFollowedBy($id = null)
    {
        if (is_null($id)) {
            return false;
        }

        if ($id instanceof self) {
            $id = $id->id;
        }

        return $this->newBaseQueryBuilder()
            ->from('users_following')
            ->where('user_id', $id)
            ->where('following_user_id', $this->id)
            ->exists();
    }

}