Rateable::countRatingForUser() - Code Metrics - yoeunes/rateable - Measure and Improve Code Quality continuously with Scrutinizer

Rateable::countRatingForUser() A
last analyzed 2018-09-12 20:14 UTC

↳ Parent: Rateable

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Yoeunes\Rateable\Traits;

use Illuminate\Support\Facades\DB;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Query\JoinClause;
use Yoeunes\Rateable\Builders\RatingBuilder;
use Yoeunes\Rateable\Builders\RatingQueryBuilder;
use Yoeunes\Rateable\Exceptions\InvalidRatingValue;

trait Rateable
{
    /**
     * This model has many ratings.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function ratings()
    {
        return $this->morphMany(config('rateable.rating'), 'rateable');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function averageRating()
    {
        return $this->ratings()->avg('value');
    }

    public function countRating()
    {
        return $this->ratings()->count();
    }

    public function totalRating()
    {
        return $this->ratings()->sum('value');
    }

    public function averageRatingForUser(int $user_id)
    {
        return $this->ratings()->where('user_id', $user_id)->avg('value');
    }

    public function totalRatingForUser(int $user_id)
    {
        return $this->ratings()->where('user_id', $user_id)->sum('value');
    }

    public function countRatingForUser(int $user_id)
    {
        return $this->ratings()->where('user_id', $user_id)->count();
    }

    public function ratingPercentage()
    {
        $max = config('rateable.max_rating');

        $quantity = $this->ratings()->count();

        $total = $this->totalRating();

        return ($quantity * $max) > 0 ? $total / (($quantity * $max) / 100) : 0;
    }

    public function positiveRatingCount()
    {
        return $this->ratings()->where('value', '>=', '0')->count();
    }

    public function positiveRatingTotal()
    {
        return $this->ratings()->where('value', '>=', '0')->sum('value');
    }

    public function negativeRatingCount()
    {
        return $this->ratings()->where('value', '<', '0')->count();
    }

    public function negativeRatingTotal()
    {
        return $this->ratings()->where('value', '<', '0')->sum('value');
    }

    public function isRated()
    {
        return $this->ratings()->exists();
    }

    public function isRatedBy(int $user_id)
    {
        return $this->ratings()->where('user_id', $user_id)->exists();
    }

    /**
     * to order by average_rating.
     *
     * add protected $appends = [ 'average_rating' ]; to your model
     *
     * Lesson::all()->sortBy('average_rating')
     * Lesson::with('relatedModel')->get()->sortBy('average_rating')
     * Lesson::where('status', 'published')->get()->sortBy('average_rating')
     *
     * @return mixed
     */
    public function getAverageRatingAttribute()
    {
        return $this->averageRating();
    }

    public function scopeOrderByAverageRating(Builder $query, string $direction = 'asc')
    {
        return $query
            ->leftJoin('ratings', function (JoinClause $join) {
                $join
                    ->on('ratings.rateable_id', $this->getTable() . '.id')
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ->where('ratings.rateable_type', morph_type(__CLASS__));
            })
            ->addSelect(DB::raw('AVG(ratings.value) as average_rating'))
            ->groupBy($this->getTable(). '.id')
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->orderBy('average_rating', $direction);
    }

    public function deleteRating(int $rating_id)
    {
        return $this->ratings()->where('id', $rating_id)->delete();
    }

    public function resetRating()
    {
        return $this->ratings()->delete();
    }

    public function deleteRatingsForUser(int $user_id)
    {
        return $this->ratings()->where('user_id', $user_id)->delete();
    }

    /**
     * @param int $user_id
     * @param int $value
     *
     * @return int
     *
     * @throws \Throwable
     */
    public function updateRatingForUser(int $user_id, int $value)
    {
        throw_if($value < config('rateable.min_rating') || $value > config('rateable.max_rating'), InvalidRatingValue::class, 'Invalid rating value');

        return $this->ratings()->where('user_id', $user_id)->update(['value' => $value]);
    }

    /**
     * @param int $rating_id
     * @param int $value
     *
     * @return int
     *
     * @throws \Throwable
     */
    public function updateRating(int $rating_id, int $value)
    {
        throw_if($value < config('rateable.min_rating') || $value > config('rateable.max_rating'), InvalidRatingValue::class, 'Invalid rating value');

        return $this->ratings()->where('id', $rating_id)->update(['value' => $value]);
    }

    /**
     * @return RatingBuilder
     *
     * @throws \Throwable
     */
    public function getRatingBuilder()
    {
        return (new RatingBuilder())
            ->rateable($this);
    }

    public function raters()
    {
        return $this->morphToMany(config('rateable.user'), 'rateable', 'ratings');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function countRatingsByDate($from = null, $to = null)
    {
        $query = $this->ratings();

        if (! empty($from) && empty($to)) {
            $query->where('created_at', '>=', date_transformer($from));
        } elseif (empty($from) && ! empty($to)) {
            $query->where('created_at', '<=', date_transformer($to));
        } elseif (! empty($from) && ! empty($to)) {
            $query->whereBetween('created_at', [date_transformer($from), date_transformer($to)]);
        }

        return $query->sum('value');
    }

    public function getRatingQueryBuilder()
    {
        return new RatingQueryBuilder($this->ratings());
    }
}


1			<?php
2
3			namespace Yoeunes\Rateable\Traits;
4
5			use Illuminate\Support\Facades\DB;
6			use Illuminate\Database\Eloquent\Builder;
7			use Illuminate\Database\Query\JoinClause;
8			use Yoeunes\Rateable\Builders\RatingBuilder;
9			use Yoeunes\Rateable\Builders\RatingQueryBuilder;
10			use Yoeunes\Rateable\Exceptions\InvalidRatingValue;
11
12			trait Rateable
13			{
14			/**
15			* This model has many ratings.
16			*
17			* @return \Illuminate\Database\Eloquent\Relations\MorphMany
18			*/
19			public function ratings()
20			{
21			return $this->morphMany(config('rateable.rating'), 'rateable');
			0 ignored issues – show Bug introduced 2018-02-05 00:13 UTC by Report Bug Copy Issue Report It seems like `morphMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
22			}
23
24			public function averageRating()
25			{
26			return $this->ratings()->avg('value');
27			}
28
29			public function countRating()
30			{
31			return $this->ratings()->count();
32			}
33
34			public function totalRating()
35			{
36			return $this->ratings()->sum('value');
37			}
38
39			public function averageRatingForUser(int $user_id)
40			{
41			return $this->ratings()->where('user_id', $user_id)->avg('value');
42			}
43
44			public function totalRatingForUser(int $user_id)
45			{
46			return $this->ratings()->where('user_id', $user_id)->sum('value');
47			}
48
49			public function countRatingForUser(int $user_id)
50			{
51			return $this->ratings()->where('user_id', $user_id)->count();
52			}
53
54			public function ratingPercentage()
55			{
56			$max = config('rateable.max_rating');
57
58			$quantity = $this->ratings()->count();
59
60			$total = $this->totalRating();
61
62			return ($quantity * $max) > 0 ? $total / (($quantity * $max) / 100) : 0;
63			}
64
65			public function positiveRatingCount()
66			{
67			return $this->ratings()->where('value', '>=', '0')->count();
68			}
69
70			public function positiveRatingTotal()
71			{
72			return $this->ratings()->where('value', '>=', '0')->sum('value');
73			}
74
75			public function negativeRatingCount()
76			{
77			return $this->ratings()->where('value', '<', '0')->count();
78			}
79
80			public function negativeRatingTotal()
81			{
82			return $this->ratings()->where('value', '<', '0')->sum('value');
83			}
84
85			public function isRated()
86			{
87			return $this->ratings()->exists();
88			}
89
90			public function isRatedBy(int $user_id)
91			{
92			return $this->ratings()->where('user_id', $user_id)->exists();
93			}
94
95			/**
96			* to order by average_rating.
97			*
98			* add protected $appends = [ 'average_rating' ]; to your model
99			*
100			* Lesson::all()->sortBy('average_rating')
101			* Lesson::with('relatedModel')->get()->sortBy('average_rating')
102			* Lesson::where('status', 'published')->get()->sortBy('average_rating')
103			*
104			* @return mixed
105			*/
106			public function getAverageRatingAttribute()
107			{
108			return $this->averageRating();
109			}
110
111			public function scopeOrderByAverageRating(Builder $query, string $direction = 'asc')
112			{
113			return $query
114			->leftJoin('ratings', function (JoinClause $join) {
115			$join
116			->on('ratings.rateable_id', $this->getTable() . '.id')
			0 ignored issues – show Bug introduced 2018-01-30 13:45 UTC by Report Bug Copy Issue Report It seems like `getTable()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
117			->where('ratings.rateable_type', morph_type(__CLASS__));
118			})
119			->addSelect(DB::raw('AVG(ratings.value) as average_rating'))
120			->groupBy($this->getTable(). '.id')
			0 ignored issues – show Bug introduced 2018-01-30 13:45 UTC by Report Bug Copy Issue Report It seems like `getTable()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
121			->orderBy('average_rating', $direction);
122			}
123
124			public function deleteRating(int $rating_id)
125			{
126			return $this->ratings()->where('id', $rating_id)->delete();
127			}
128
129			public function resetRating()
130			{
131			return $this->ratings()->delete();
132			}
133
134			public function deleteRatingsForUser(int $user_id)
135			{
136			return $this->ratings()->where('user_id', $user_id)->delete();
137			}
138
139			/**
140			* @param int $user_id
141			* @param int $value
142			*
143			* @return int
144			*
145			* @throws \Throwable
146			*/
147			public function updateRatingForUser(int $user_id, int $value)
148			{
149			throw_if($value < config('rateable.min_rating') \|\| $value > config('rateable.max_rating'), InvalidRatingValue::class, 'Invalid rating value');
150
151			return $this->ratings()->where('user_id', $user_id)->update(['value' => $value]);
152			}
153
154			/**
155			* @param int $rating_id
156			* @param int $value
157			*
158			* @return int
159			*
160			* @throws \Throwable
161			*/
162			public function updateRating(int $rating_id, int $value)
163			{
164			throw_if($value < config('rateable.min_rating') \|\| $value > config('rateable.max_rating'), InvalidRatingValue::class, 'Invalid rating value');
165
166			return $this->ratings()->where('id', $rating_id)->update(['value' => $value]);
167			}
168
169			/**
170			* @return RatingBuilder
171			*
172			* @throws \Throwable
173			*/
174			public function getRatingBuilder()
175			{
176			return (new RatingBuilder())
177			->rateable($this);
178			}
179
180			public function raters()
181			{
182			return $this->morphToMany(config('rateable.user'), 'rateable', 'ratings');
			0 ignored issues – show Bug introduced 2018-02-04 16:39 UTC by Report Bug Copy Issue Report It seems like `morphToMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
183			}
184
185			public function countRatingsByDate($from = null, $to = null)
186			{
187			$query = $this->ratings();
188
189			if (! empty($from) && empty($to)) {
190			$query->where('created_at', '>=', date_transformer($from));
191			} elseif (empty($from) && ! empty($to)) {
192			$query->where('created_at', '<=', date_transformer($to));
193			} elseif (! empty($from) && ! empty($to)) {
194			$query->whereBetween('created_at', [date_transformer($from), date_transformer($to)]);
195			}
196
197			return $query->sum('value');
198			}
199
200			public function getRatingQueryBuilder()
201			{
202			return new RatingQueryBuilder($this->ratings());
203			}
204			}
205

yoeunes / rateable

Rateable::countRatingForUser() A last analyzed 2018-09-12 20:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Rateable::countRatingForUser() A
last analyzed 2018-09-12 20:14 UTC