turahe / laravel-likeable

src/Traits/Likeable.php

<?php

namespace Turahe\Likeable\Traits;

use Turahe\Likeable\Enums\LikeType;
use Illuminate\Database\Eloquent\Builder;
use Turahe\Likeable\Observers\ModelObserver;
use Turahe\Likeable\Contracts\Like as LikeContract;
use Turahe\Likeable\Contracts\LikeCounter as LikeCounterContract;
use Turahe\Likeable\Contracts\LikeableService as LikeableServiceContract;

trait Likeable
{
    /**
     * Boot the Likeable trait for a model.
     *
     * @return void
     */
    public static function bootLikeable()
    {
        static::observe(ModelObserver::class);
    }

    /**
     * Collection of likes and dislikes on this record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function likesAndDislikes()
    {
        return $this->morphMany(app(LikeContract::class), 'likeable');

It seems like morphMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Collection of likes on this record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function likes()
    {
        return $this->likesAndDislikes()->where('type_id', LikeType::LIKE);
    }

    /**
     * Collection of dislikes on this record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function dislikes()
    {
        return $this->likesAndDislikes()->where('type_id', LikeType::DISLIKE);
    }

    /**
     * Counter is a record that stores the total likes for the morphed record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphOne
     */
    public function likesCounter()
    {
        return $this->morphOne(app(LikeCounterContract::class), 'likeable')

It seems like morphOne() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            ->where('type_id', LikeType::LIKE);
    }

    /**
     * Counter is a record that stores the total dislikes for the morphed record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphOne
     */
    public function dislikesCounter()
    {
        return $this->morphOne(app(LikeCounterContract::class), 'likeable')
            ->where('type_id', LikeType::DISLIKE);
    }

    /**
     * Fetch users who liked entity.
     *
     * @return \Illuminate\Support\Collection
     */
    public function collectLikers()
    {
        return app(LikeableServiceContract::class)->collectLikersOf($this);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::collectLikersOf().

    }

    /**
     * Fetch users who disliked entity.
     *
     * @return \Illuminate\Support\Collection
     */
    public function collectDislikers()
    {
        return app(LikeableServiceContract::class)->collectDislikersOf($this);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::collectDislikersOf().

    }

    /**
     * Model likesCount attribute.
     *
     * @return int
     */
    public function getLikesCountAttribute()
    {
        return $this->likesCounter ? $this->likesCounter->count : 0;
    }

    /**
     * Model dislikesCount attribute.
     *
     * @return int
     */
    public function getDislikesCountAttribute()
    {
        return $this->dislikesCounter ? $this->dislikesCounter->count : 0;
    }

    /**
     * Did the currently logged in user like this model.
     *
     * @return bool
     */
    public function getLikedAttribute()
    {
        return $this->liked();
    }

    /**
     * Did the currently logged in user dislike this model.
     *
     * @return bool
     */
    public function getDislikedAttribute()
    {
        return $this->disliked();
    }

    /**
     * Difference between likes and dislikes count.
     *
     * @return int
     */
    public function getLikesDiffDislikesCountAttribute()
    {
        return $this->likesCount - $this->dislikesCount;
    }

    /**
     * Fetch records that are liked by a given user id.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param int|null $userId
     * @return \Illuminate\Database\Eloquent\Builder
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function scopeWhereLikedBy(Builder $query, $userId = null)
    {
        return app(LikeableServiceContract::class)
            ->scopeWhereLikedBy($query, LikeType::LIKE, $userId);
    }

    /**
     * Fetch records that are disliked by a given user id.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param int|null $userId
     * @return \Illuminate\Database\Eloquent\Builder
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function scopeWhereDislikedBy(Builder $query, $userId = null)
    {
        return app(LikeableServiceContract::class)
            ->scopeWhereLikedBy($query, LikeType::DISLIKE, $userId);
    }

    /**
     * Fetch records sorted by likes count.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string $direction
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOrderByLikesCount(Builder $query, $direction = 'desc')
    {
        return app(LikeableServiceContract::class)
            ->scopeOrderByLikesCount($query, LikeType::LIKE, $direction);
    }

    /**
     * Fetch records sorted by likes count.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string $direction
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOrderByDislikesCount(Builder $query, $direction = 'desc')
    {
        return app(LikeableServiceContract::class)
            ->scopeOrderByLikesCount($query, LikeType::DISLIKE, $direction);
    }

    /**
     * Add a like for model by the given user.
     *
     * @param mixed $userId If null will use currently logged in user.
     * @return void
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function like($userId = null)
    {
        app(LikeableServiceContract::class)->addLikeTo($this, LikeType::LIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::addLikeTo().

    }

    /**
     * Remove a like from this record for the given user.
     *
     * @param int|null $userId If null will use currently logged in user.
     * @return void
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function unlike($userId = null)
    {
        app(LikeableServiceContract::class)->removeLikeFrom($this, LikeType::LIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::removeLikeFrom().

    }

    /**
     * Toggle like for model by the given user.
     *
     * @param mixed $userId If null will use currently logged in user.
     * @return void
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function likeToggle($userId = null)
    {
        app(LikeableServiceContract::class)->toggleLikeOf($this, LikeType::LIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::toggleLikeOf().

    }

    /**
     * Has the user already liked likeable model.
     *
     * @param int|null $userId
     * @return bool
     */
    public function liked($userId = null)
    {
        return app(LikeableServiceContract::class)->isLiked($this, LikeType::LIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::isLiked().

    }

    /**
     * Delete likes related to the current record.
     *
     * @return void
     */
    public function removeLikes()
    {
        app(LikeableServiceContract::class)->removeModelLikes($this, LikeType::LIKE);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::removeModelLikes().

    }

    /**
     * Add a dislike for model by the given user.
     *
     * @param mixed $userId If null will use currently logged in user.
     * @return void
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function dislike($userId = null)
    {
        app(LikeableServiceContract::class)->addLikeTo($this, LikeType::DISLIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::addLikeTo().

    }

    /**
     * Remove a dislike from this record for the given user.
     *
     * @param int|null $userId If null will use currently logged in user.
     * @return void
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function undislike($userId = null)
    {
        app(LikeableServiceContract::class)->removeLikeFrom($this, LikeType::DISLIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::removeLikeFrom().

    }

    /**
     * Toggle dislike for model by the given user.
     *
     * @param mixed $userId If null will use currently logged in user.
     * @return void
     *
     * @throws \Turahe\Likeable\Exceptions\LikerNotDefinedException
     */
    public function dislikeToggle($userId = null)
    {
        app(LikeableServiceContract::class)->toggleLikeOf($this, LikeType::DISLIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::toggleLikeOf().

    }

    /**
     * Has the user already disliked likeable model.
     *
     * @param int|null $userId
     * @return bool
     */
    public function disliked($userId = null)
    {
        return app(LikeableServiceContract::class)->isLiked($this, LikeType::DISLIKE, $userId);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::isLiked().

    }

    /**
     * Delete dislikes related to the current record.
     *
     * @return void
     */
    public function removeDislikes()
    {
        app(LikeableServiceContract::class)->removeModelLikes($this, LikeType::DISLIKE);

$this of type Turahe\Likeable\Traits\Likeable is incompatible with the type Turahe\Likeable\Contracts\Likeable expected by parameter $likeable of Turahe\Likeable\Contracts\LikeableService::removeModelLikes().

    }
}