Issues in HasTags.php - Fixed Issues - Inspection of "Use taggable_type in scopeWithAllTags(*) (#207)" - spatie/laravel-tags - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3fa0ab...4d90c4 )

by Freek

created 2019-07-17 12:39 UTC

src/HasTags.php (5 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Spatie\Tags;

use InvalidArgumentException;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Relations\MorphToMany;

trait HasTags
{
    protected $queuedTags = [];

    public static function getTagClassName(): string
    {
        return Tag::class;
    }

    public static function bootHasTags()
    {
        static::created(function (Model $taggableModel) {
            if (count($taggableModel->queuedTags) > 0) {
                $taggableModel->attachTags($taggableModel->queuedTags);

                $taggableModel->queuedTags = [];
            }
        });

        static::deleted(function (Model $deletedModel) {
            $tags = $deletedModel->tags()->get();

            $deletedModel->detachTags($tags);
        });
    }

    public function tags(): MorphToMany
    {
        return $this
            ->morphToMany(self::getTagClassName(), 'taggable')
            ->ordered();
    }

    /**
     * @param string $locale
     */
    public function tagsTranslated($locale = null): MorphToMany
    {
        $locale = ! is_null($locale) ? $locale : app()->getLocale();

        return $this
            ->morphToMany(self::getTagClassName(), 'taggable')
            ->select('*')
            ->selectRaw("JSON_UNQUOTE(JSON_EXTRACT(name, '$.\"{$locale}\"')) as name_translated")
            ->selectRaw("JSON_UNQUOTE(JSON_EXTRACT(slug, '$.\"{$locale}\"')) as slug_translated")
            ->ordered();
    }

    /**
     * @param string|array|\ArrayAccess|\Spatie\Tags\Tag $tags
     */
    public function setTagsAttribute($tags)
    {
        if (! $this->exists) {
            $this->queuedTags = $tags;

            return;
        }

        $this->attachTags($tags);
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param array|\ArrayAccess|\Spatie\Tags\Tag $tags
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWithAllTags(Builder $query, $tags, string $type = null): Builder

    {
        $tags = static::convertToTags($tags, $type);

        collect($tags)->each(function ($tag) use ($query) {
            $query->whereIn("{$this->getTable()}.{$this->getKeyName()}", function ($query) use ($tag) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $query->from('taggables')
                    ->select('taggables.taggable_id')
                    ->where('taggables.tag_id', $tag ? $tag->id : 0);
            });
        });

        return $query;
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param array|\ArrayAccess|\Spatie\Tags\Tag $tags
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWithAnyTags(Builder $query, $tags, string $type = null): Builder
    {
        $tags = static::convertToTags($tags, $type);

        return $query->whereHas('tags', function (Builder $query) use ($tags) {
            $tagIds = collect($tags)->pluck('id');

            $query->whereIn('tags.id', $tagIds);
        });
    }

    public function scopeWithAllTagsOfAnyType(Builder $query, $tags): Builder
    {
        $tags = static::convertToTagsOfAnyType($tags);

        collect($tags)->each(function ($tag) use ($query) {
            $query->whereIn("{$this->getTable()}.{$this->getKeyName()}", function ($query) use ($tag) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $query->from('taggables')
                    ->select('taggables.taggable_id')
                    ->where('taggables.tag_id', $tag ? $tag->id : 0);
            });
        });

        return $query;
    }

    public function scopeWithAnyTagsOfAnyType(Builder $query, $tags): Builder
    {
        $tags = static::convertToTagsOfAnyType($tags);

        return $query->whereHas('tags', function (Builder $query) use ($tags) {
            $tagIds = collect($tags)->pluck('id');

            $query->whereIn('tags.id', $tagIds);
        });
    }

    public function tagsWithType(string $type = null): Collection
    {
        return $this->tags->filter(function (Tag $tag) use ($type) {
            return $tag->type === $type;
        });
    }

    /**
     * @param array|\ArrayAccess|\Spatie\Tags\Tag $tags
     *
     * @return $this
     */
    public function attachTags($tags)
    {
        $className = static::getTagClassName();

        $tags = collect($className::findOrCreate($tags));

        $this->tags()->syncWithoutDetaching($tags->pluck('id')->toArray());

        return $this;
    }

    /**
     * @param string|\Spatie\Tags\Tag $tag
     *
     * @return $this
     */
    public function attachTag($tag)
    {
        return $this->attachTags([$tag]);
    }

    /**
     * @param array|\ArrayAccess $tags
     *
     * @return $this
     */
    public function detachTags($tags)
    {
        $tags = static::convertToTags($tags);

        collect($tags)
            ->filter()
            ->each(function (Tag $tag) {
                $this->tags()->detach($tag);
            });

        return $this;
    }

    /**
     * @param string|\Spatie\Tags\Tag $tag
     *
     * @return $this
     */
    public function detachTag($tag)
    {
        return $this->detachTags([$tag]);
    }

    /**
     * @param array|\ArrayAccess $tags
     *
     * @return $this
     */
    public function syncTags($tags)
    {
        $className = static::getTagClassName();

        $tags = collect($className::findOrCreate($tags));

        $this->tags()->sync($tags->pluck('id')->toArray());

        return $this;
    }

    /**
     * @param array|\ArrayAccess $tags
     * @param string|null $type
     *
     * @return $this
     */
    public function syncTagsWithType($tags, string $type = null)
    {
        $className = static::getTagClassName();

        $tags = collect($className::findOrCreate($tags, $type));

        $this->syncTagIds($tags->pluck('id')->toArray(), $type);

        return $this;
    }

    protected static function convertToTags($values, $type = null, $locale = null)
    {
        return collect($values)->map(function ($value) use ($type, $locale) {
            if ($value instanceof Tag) {
                if (isset($type) && $value->type != $type) {
                    throw new InvalidArgumentException("Type was set to {$type} but tag is of type {$value->type}");
                }

                return $value;
            }

            $className = static::getTagClassName();

            return $className::findFromString($value, $type, $locale);
        });
    }

    protected static function convertToTagsOfAnyType($values, $locale = null)
    {
        return collect($values)->map(function ($value) use ($locale) {
            if ($value instanceof Tag) {
                return $value;
            }

            $className = static::getTagClassName();

            return $className::findFromStringOfAnyType($value, $locale);
        });
    }

    /**
     * Use in place of eloquent's sync() method so that the tag type may be optionally specified.
     *
     * @param $ids
     * @param string|null $type
     * @param bool $detaching
     */
    protected function syncTagIds($ids, string $type = null, $detaching = true)
    {
        $isUpdated = false;

        // Get a list of tag_ids for all current tags
        $current = $this->tags()
            ->newPivotStatement()
            ->where('taggable_id', $this->getKey())
            ->where('taggable_type', $this->getMorphClass())
            ->when($type !== null, function ($query) use ($type) {
                $tagModel = $this->tags()->getRelated();

                return $query->join(
                    $tagModel->getTable(),
                    'taggables.tag_id',
                    '=',
                    $tagModel->getTable().'.'.$tagModel->getKeyName()
                )
                    ->where('tags.type', $type);
            })
            ->pluck('tag_id')
            ->all();

        // Compare to the list of ids given to find the tags to remove
        $detach = array_diff($current, $ids);
        if ($detaching && count($detach) > 0) {
            $this->tags()->detach($detach);
            $isUpdated = true;
        }

        // Attach any new ids
        $attach = array_diff($ids, $current);
        if (count($attach) > 0) {
            collect($attach)->each(function ($id) {
                $this->tags()->attach($id, []);
            });
            $isUpdated = true;
        }

        // Once we have finished attaching or detaching the records, we will see if we
        // have done any attaching or detaching, and if we have we will touch these
        // relationships if they are configured to touch on any database updates.
        if ($isUpdated) {
            $this->tags()->touchIfTouching();
        }
    }
}


1		<?php
2
3		namespace Spatie\Tags;
4
5		use InvalidArgumentException;
6		use Illuminate\Database\Eloquent\Model;
7		use Illuminate\Database\Eloquent\Builder;
8		use Illuminate\Database\Eloquent\Collection;
9		use Illuminate\Database\Eloquent\Relations\MorphToMany;
10
11		trait HasTags
12		{
13		protected $queuedTags = [];
14
15		public static function getTagClassName(): string
16		{
17		return Tag::class;
18		}
19
20		public static function bootHasTags()
21		{
22		static::created(function (Model $taggableModel) {
23		if (count($taggableModel->queuedTags) > 0) {
24		$taggableModel->attachTags($taggableModel->queuedTags);
25
26		$taggableModel->queuedTags = [];
27		}
28		});
29
30		static::deleted(function (Model $deletedModel) {
31		$tags = $deletedModel->tags()->get();
32
33		$deletedModel->detachTags($tags);
34		});
35		}
36
37		public function tags(): MorphToMany
38		{
39		return $this
40		->morphToMany(self::getTagClassName(), 'taggable')
41		->ordered();
42		}
43
44		/**
45		* @param string $locale
46		*/
47		public function tagsTranslated($locale = null): MorphToMany
48		{
49		$locale = ! is_null($locale) ? $locale : app()->getLocale();
50
51		return $this
52		->morphToMany(self::getTagClassName(), 'taggable')
53		->select('*')
54		->selectRaw("JSON_UNQUOTE(JSON_EXTRACT(name, '$.\"{$locale}\"')) as name_translated")
55		->selectRaw("JSON_UNQUOTE(JSON_EXTRACT(slug, '$.\"{$locale}\"')) as slug_translated")
56		->ordered();
57		}
58
59		/**
60		* @param string\|array\|\ArrayAccess\|\Spatie\Tags\Tag $tags
61		*/
62		public function setTagsAttribute($tags)
63		{
64		if (! $this->exists) {
65		$this->queuedTags = $tags;
66
67		return;
68		}
69
70		$this->attachTags($tags);
71		}
72
73		/**
74		* @param \Illuminate\Database\Eloquent\Builder $query
75		* @param array\|\ArrayAccess\|\Spatie\Tags\Tag $tags
76		*
77		* @return \Illuminate\Database\Eloquent\Builder
78		*/
79	View Code Duplication	public function scopeWithAllTags(Builder $query, $tags, string $type = null): Builder
		0 ignored issues – show Duplication introduced 2017-08-03 11:34 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
80		{
81		$tags = static::convertToTags($tags, $type);
82
83		collect($tags)->each(function ($tag) use ($query) {
84		$query->whereIn("{$this->getTable()}.{$this->getKeyName()}", function ($query) use ($tag) {
		0 ignored issues – show Bug introduced 2018-11-01 07:47 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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... Bug introduced 2018-09-16 08:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `getKeyName()` 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...
85		$query->from('taggables')
86		->select('taggables.taggable_id')
87		->where('taggables.tag_id', $tag ? $tag->id : 0);
88		});
89		});
90
91		return $query;
92		}
93
94		/**
95		* @param \Illuminate\Database\Eloquent\Builder $query
96		* @param array\|\ArrayAccess\|\Spatie\Tags\Tag $tags
97		*
98		* @return \Illuminate\Database\Eloquent\Builder
99		*/
100	View Code Duplication	public function scopeWithAnyTags(Builder $query, $tags, string $type = null): Builder
101		{
102		$tags = static::convertToTags($tags, $type);
103
104		return $query->whereHas('tags', function (Builder $query) use ($tags) {
105		$tagIds = collect($tags)->pluck('id');
106
107		$query->whereIn('tags.id', $tagIds);
108		});
109		}
110
111	View Code Duplication	public function scopeWithAllTagsOfAnyType(Builder $query, $tags): Builder
112		{
113		$tags = static::convertToTagsOfAnyType($tags);
114
115		collect($tags)->each(function ($tag) use ($query) {
116		$query->whereIn("{$this->getTable()}.{$this->getKeyName()}", function ($query) use ($tag) {
		0 ignored issues – show Bug introduced 2018-12-17 18:29 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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... Bug introduced 2018-12-17 18:29 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `getKeyName()` 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		$query->from('taggables')
118		->select('taggables.taggable_id')
119		->where('taggables.tag_id', $tag ? $tag->id : 0);
120		});
121		});
122
123		return $query;
124		}
125
126	View Code Duplication	public function scopeWithAnyTagsOfAnyType(Builder $query, $tags): Builder
127		{
128		$tags = static::convertToTagsOfAnyType($tags);
129
130		return $query->whereHas('tags', function (Builder $query) use ($tags) {
131		$tagIds = collect($tags)->pluck('id');
132
133		$query->whereIn('tags.id', $tagIds);
134		});
135		}
136
137		public function tagsWithType(string $type = null): Collection
138		{
139		return $this->tags->filter(function (Tag $tag) use ($type) {
140		return $tag->type === $type;
141		});
142		}
143
144		/**
145		* @param array\|\ArrayAccess\|\Spatie\Tags\Tag $tags
146		*
147		* @return $this
148		*/
149	View Code Duplication	public function attachTags($tags)
150		{
151		$className = static::getTagClassName();
152
153		$tags = collect($className::findOrCreate($tags));
154
155		$this->tags()->syncWithoutDetaching($tags->pluck('id')->toArray());
156
157		return $this;
158		}
159
160		/**
161		* @param string\|\Spatie\Tags\Tag $tag
162		*
163		* @return $this
164		*/
165		public function attachTag($tag)
166		{
167		return $this->attachTags([$tag]);
168		}
169
170		/**
171		* @param array\|\ArrayAccess $tags
172		*
173		* @return $this
174		*/
175		public function detachTags($tags)
176		{
177		$tags = static::convertToTags($tags);
178
179		collect($tags)
180		->filter()
181		->each(function (Tag $tag) {
182		$this->tags()->detach($tag);
183		});
184
185		return $this;
186		}
187
188		/**
189		* @param string\|\Spatie\Tags\Tag $tag
190		*
191		* @return $this
192		*/
193		public function detachTag($tag)
194		{
195		return $this->detachTags([$tag]);
196		}
197
198		/**
199		* @param array\|\ArrayAccess $tags
200		*
201		* @return $this
202		*/
203	View Code Duplication	public function syncTags($tags)
204		{
205		$className = static::getTagClassName();
206
207		$tags = collect($className::findOrCreate($tags));
208
209		$this->tags()->sync($tags->pluck('id')->toArray());
210
211		return $this;
212		}
213
214		/**
215		* @param array\|\ArrayAccess $tags
216		* @param string\|null $type
217		*
218		* @return $this
219		*/
220	View Code Duplication	public function syncTagsWithType($tags, string $type = null)
221		{
222		$className = static::getTagClassName();
223
224		$tags = collect($className::findOrCreate($tags, $type));
225
226		$this->syncTagIds($tags->pluck('id')->toArray(), $type);
227
228		return $this;
229		}
230
231		protected static function convertToTags($values, $type = null, $locale = null)
232		{
233		return collect($values)->map(function ($value) use ($type, $locale) {
234		if ($value instanceof Tag) {
235		if (isset($type) && $value->type != $type) {
236		throw new InvalidArgumentException("Type was set to {$type} but tag is of type {$value->type}");
237		}
238
239		return $value;
240		}
241
242		$className = static::getTagClassName();
243
244		return $className::findFromString($value, $type, $locale);
245		});
246		}
247
248		protected static function convertToTagsOfAnyType($values, $locale = null)
249		{
250		return collect($values)->map(function ($value) use ($locale) {
251		if ($value instanceof Tag) {
252		return $value;
253		}
254
255		$className = static::getTagClassName();
256
257		return $className::findFromStringOfAnyType($value, $locale);
258		});
259		}
260
261		/**
262		* Use in place of eloquent's sync() method so that the tag type may be optionally specified.
263		*
264		* @param $ids
265		* @param string\|null $type
266		* @param bool $detaching
267		*/
268		protected function syncTagIds($ids, string $type = null, $detaching = true)
269		{
270		$isUpdated = false;
271
272		// Get a list of tag_ids for all current tags
273		$current = $this->tags()
274		->newPivotStatement()
275		->where('taggable_id', $this->getKey())
276		->where('taggable_type', $this->getMorphClass())
277		->when($type !== null, function ($query) use ($type) {
278		$tagModel = $this->tags()->getRelated();
279
280		return $query->join(
281		$tagModel->getTable(),
282		'taggables.tag_id',
283		'=',
284		$tagModel->getTable().'.'.$tagModel->getKeyName()
285		)
286		->where('tags.type', $type);
287		})
288		->pluck('tag_id')
289		->all();
290
291		// Compare to the list of ids given to find the tags to remove
292		$detach = array_diff($current, $ids);
293		if ($detaching && count($detach) > 0) {
294		$this->tags()->detach($detach);
295		$isUpdated = true;
296		}
297
298		// Attach any new ids
299		$attach = array_diff($ids, $current);
300		if (count($attach) > 0) {
301		collect($attach)->each(function ($id) {
302		$this->tags()->attach($id, []);
303		});
304		$isUpdated = true;
305		}
306
307		// Once we have finished attaching or detaching the records, we will see if we
308		// have done any attaching or detaching, and if we have we will touch these
309		// relationships if they are configured to touch on any database updates.
310		if ($isUpdated) {
311		$this->tags()->touchIfTouching();
312		}
313		}
314		}
315

spatie / laravel-tags

Push — master ( 3fa0ab...4d90c4 )

src/HasTags.php (5 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like