Add without tags scope (#428)

* Add without tags scope * Update HasTagsTest.php * Update README.md Co-authored-by: Stefan Damjanovic <> Co-authored-by: Freek Van der Herten <[email protected]>
spatie · Nov 19, 2022 · 0f6b46f · 0f6b46f
1 parent f9e438f
commit 0f6b46f
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,9 @@ NewsItem::withAnyTags(['first tag', 'second tag'])->get();
 // retrieve models that have all of the given tags
 NewsItem::withAllTags(['first tag', 'second tag'])->get();
 
+// retrieve models that don't have any of the given tags
+NewsItem::withoutTags(['first tag', 'second tag'])->get();
+
 // translating a tag
 $tag = Tag::findOrCreate('my tag');
 $tag->setTranslation('name', 'fr', 'mon tag');

diff --git a/src/HasTags.php b/src/HasTags.php
@@ -99,6 +99,21 @@ public function scopeWithAnyTags(
             });
     }
 
+    public function scopeWithoutTags(
+        Builder $query,
+        string | array | ArrayAccess | Tag $tags,
+        string $type = null
+    ): Builder {
+        $tags = static::convertToTags($tags, $type);
+
+        return $query
+            ->whereDoesntHave('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);

diff --git a/tests/HasTagsTest.php b/tests/HasTagsTest.php
@@ -238,6 +238,29 @@
 });
 
 
+it('provides a scope to get all models that do not have any of the given tags', function () {
+    $this->testModel->attachTag('tagA');
+
+    TestModel::create([
+        'name' => 'model1',
+        'tags' => ['tagA', 'tagB'],
+    ]);
+
+    TestModel::create([
+        'name' => 'model2',
+        'tags' => ['tagA', 'tagB', 'tagC'],
+    ]);
+
+    $testModels = TestModel::withoutTags(['tagC']);
+
+    expect($testModels->pluck('name')->toArray())->toEqual(['default', 'model1']);
+
+    $testModels = TestModel::withoutTags(['tagC', 'tagB']);
+
+    expect($testModels->pluck('name')->toArray())->toEqual(['default']);
+});
+
+
 it('provides a scope to get all models that have any of the given tag instances', function () {
     $tag = Tag::findOrCreate('tagA', 'typeA');