canylmz / laravel-rating

src/CanRate.php

<?php

namespace Canylmz\Rating;

use Canylmz\Rating\Contracts\Rating;
use Canylmz\Rating\Contracts\Rateable;
use Canylmz\Rating\Exceptions\ModelNotRateable;
use Canylmz\Rating\Exceptions\RatingAlreadyExists;

trait CanRate
{
    /**
     * Relationship for models that this model currently rated.
     *
     * @param Model $model The model types of the results.
     * @return morphToMany The relationship.

The type Canylmz\Rating\morphToMany was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function ratings($model = null)
    {
        return $this->morphToMany(($model) ?: $this->getMorphClass(), 'rater', 'ratings', 'rater_id', 'rateable_id')

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

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

            ->withPivot('rateable_type', 'rating')
            ->wherePivot('rateable_type', ($model) ?: $this->getMorphClass())
            ->wherePivot('rater_type', $this->getMorphClass());
    }

    /**
     * Check if a model can be rated.
     *
     * @param Model $model The model to check
     * @return bool
     */
    public function isRateable($model): bool
    {
        if (! $model instanceof Rateable && ! $model instanceof Rating) {
            throw ModelNotRateable::create($model);
        }

        return true;
    }

    /**
     * Check if the current model is rating another model.
     *
     * @param Model $model The model which will be checked against.
     * @return bool
     */
    public function hasRated($model): bool
    {
        if (! $this->isRateable($model)) {
            return false;
        }

        return (bool) ! is_null($this->ratings($model->getMorphClass())->find($model->getKey()));

The method getKey() does not exist on Canylmz\Rating\Contracts\Rateable. It seems like you code against a sub-type of said class. However, the method does not exist in Canylmz\Rating\Contracts\Rating. Are you sure you never get one of those?

The method getMorphClass() does not exist on Canylmz\Rating\Contracts\Rateable. It seems like you code against a sub-type of said class. However, the method does not exist in Canylmz\Rating\Contracts\Rating. Are you sure you never get one of those?

The method getKey() does not exist on Canylmz\Rating\Contracts\Rating. Since it exists in all sub-types, consider adding an abstract or default implementation to Canylmz\Rating\Contracts\Rating.

The method getMorphClass() does not exist on Canylmz\Rating\Contracts\Rating. Since it exists in all sub-types, consider adding an abstract or default implementation to Canylmz\Rating\Contracts\Rating.

    }

    /**
     * Add rating for a certain model.
     *
     * @param Model $model The model which will be rated.
     * @param float $rating The rate amount.
     * @return bool
     */
    public function addRatingFor($model, $rating): bool
    {
        if (! $this->isRateable($model)) {
            return false;
        }

        if ($this->hasRated($model)) {
            throw RatingAlreadyExists::create($model);

It seems like $model can also be of type Canylmz\Rating\Contracts\Rating; however, parameter $className of Canylmz\Rating\Exceptions\RatingAlreadyExists::create() does only seem to accept string, maybe add an additional type check?

        }

        $this->ratings()->attach($this->getKey(), [

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

            'rater_id' => $this->getKey(),
            'rateable_type' => $model->getMorphClass(),
            'rateable_id' => $model->getKey(),
            'rating' => (float) $rating,
        ]);

        return true;
    }

    /**
     * Update or add rating for a certain model.
     *
     * @param Model $model The model which will be rated.
     * @param float $rating The rate amount.
     * @return bool
     */
    public function updateRatingFor($model, $rating): bool
    {
        if (! $this->isRateable($model)) {
            return false;
        }

        if ($this->hasRated($model)) {
            $this->deleteRatingFor($model);
        }

        return $this->addRatingFor($model, $rating);
    }

    /**
     * Rate a certain model.
     *
     * @param Model $model The model which will be rated.
     * @param float $rating The rate amount.
     * @param bool $can_update Set to false if a rating can only be added once
     * @return bool
     */
    public function rate($model, $rating, $can_update = true): bool
    {
        if ($can_update === true) {
            return $this->updateRatingFor($model, $rating);
        }

        return $this->addRatingFor($model, $rating);
    }

    /**
     * Delete rating for a certain model.
     *
     * @param Model $model The model which will be unrated.
     * @return bool
     */
    public function deleteRatingFor($model): bool
    {
        if (! $this->isRateable($model)) {
            return false;
        }

        if (! $this->hasRated($model)) {
            return false;
        }

        return (bool) $this->ratings($model->getMorphClass())->detach($model->getKey());
    }

    /**
     * Unrate a certain model.
     *
     * @param Model $model The model which will be unrated.
     * @return bool
     */
    public function unrate($model): bool
    {
        return $this->deleteRatingFor($model);
    }
}