Add withAnyTagsOfType scope (#535)

* Add withAnyTagsOfType scope

This update allows you to filter models that have any tags of a certain type.

* Add examples to documentation

Author: voicecode-bv

README.md

@@ -102,6 +102,10 @@ $tag->swapOrder($anotherTag);
 // checking if a model has a tag
 $newsItem->hasTag('first tag');
 $newsItem->hasTag('first tag', 'some_type');
+
+// Retrieve models that have tags of a 
+Model::withAnyTagsOfType('type');
+Model::withAnyTagsOfType(['first type', 'second type']);
 ```
 
 Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).

src/HasTags.php

@@ -178,6 +178,14 @@ public function scopeWithAnyTagsOfAnyType(Builder $query, $tags): Builder
         );
     }
 
+    public function scopeWithAnyTagsOfType(Builder $query, string|array $type): Builder
+    {
+        return $query->whereHas(
+            'tags',
+            fn (Builder $query) => $query->whereIn('type', (array) $type)
+        );
+    }
+
     public function tagsWithType(?string $type = null): Collection
     {
         return $this->tags->filter(fn (Tag $tag) => $tag->type === $type);

tests/HasTagsScopesTest.php

@@ -26,6 +26,7 @@
 
     $typedTag = Tag::findOrCreate('tagE', 'typedTag');
     $anotherTypedTag = Tag::findOrCreate('tagF', 'typedTag');
+    $tagWithSecondType = Tag::findOrCreate('tagG', 'secondType');
 
     TestModel::create([
         'name' => 'model5',
@@ -36,8 +37,30 @@
         'name' => 'model6',
         'tags' => [$typedTag],
     ]);
+
+    TestModel::create([
+        'name' => 'model7',
+        'tags' => [$typedTag, $tagWithSecondType],
+    ]);
 });
 
+it('provides as scope to get all models that have any tags of the given types', function () {
+    // String input
+    $testModels = TestModel::withAnyTagsOfType('typedTag')->get();
+
+    expect($testModels->pluck('name')
+        ->toArray())
+        ->toContain('model5', 'model6')
+        ->not->toContain('model3', 'model7');    
+
+    // Array input
+    $testModels = TestModel::withAnyTagsOfType(['typedTag', 'secondType'])->get();
+
+    expect($testModels->pluck('name')
+        ->toArray())
+        ->toContain('model5', 'model6', 'model7')
+        ->not->toContain('model3');    
+});
 
 it('provides a scope to get all models that have any of the given tags', function () {
     $testModels = TestModel::withAnyTags(['tagC', 'tagD'])->get();