Merge pull request #89 from erikn69/scope_with_operator

Scope retrieving models with operator
spatie · Nov 8, 2021 · f731d35 · f731d35
2 parents ddc9e5f + 2d69725
commit f731d35
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -232,6 +232,13 @@ If you only want to search on a single custom attribute, you can use the modelSc
 $yourModel->withExtraAttributes('name', 'value')->get();
 ```
 
+Also, if you only want to search on a single custom attribute with a custom operator, you can use the modelScope like this
+
+```php
+// returns all models that have a schemaless attribute `name` starting with `value`
+$yourModel->withExtraAttributes('name', 'LIKE', 'value%')->get();
+```
+
 If you only want to search on a nested custom attribute, you can use the modelScope like this
 
 ```php

diff --git a/src/SchemalessAttributes.php b/src/SchemalessAttributes.php
@@ -111,13 +111,18 @@ public function modelScope(): Builder
             [$builder, $schemalessAttributes] = $arguments;
         }
 
-        if (count($arguments) >= 3) {
+        if (count($arguments) === 3) {
             [$builder, $name, $value] = $arguments;
             $schemalessAttributes = [$name => $value];
         }
 
+        if (count($arguments) >= 4) {
+            [$builder, $name, $operator, $value] = $arguments;
+            $schemalessAttributes = [$name => $value];
+        }
+
         foreach ($schemalessAttributes as $name => $value) {
-            $builder->where("{$this->sourceAttributeName}->{$name}", $value);
+            $builder->where("{$this->sourceAttributeName}->{$name}", $operator ?? '=', $value);
         }
 
         return $builder;

diff --git a/tests/HasSchemalessAttributesTest.php b/tests/HasSchemalessAttributesTest.php
@@ -274,16 +274,25 @@ public function it_has_a_scope_to_get_models_with_the_given_schemaless_attribute
         $model1 = TestModel::create(['schemaless_attributes' => [
             'name' => 'value',
             'name2' => 'value2',
+            'arr' => [
+                'subKey1' => 'subVal1'
+            ]
         ]]);
 
         $model2 = TestModel::create(['schemaless_attributes' => [
             'name' => 'value',
             'name2' => 'value2',
+            'arr' => [
+                'subKey1' => 'subVal1'
+            ]
         ]]);
 
         $model3 = TestModel::create(['schemaless_attributes' => [
             'name' => 'value',
             'name2' => 'value3',
+            'arr' => [
+                'subKey1' => 'subVal2'
+            ]
         ]]);
 
         $this->assertContainsModels([
@@ -306,7 +315,16 @@ public function it_has_a_scope_to_get_models_with_the_given_schemaless_attribute
         ], TestModel::withSchemalessAttributes('name', 'value')->get());
 
         $this->assertContainsModels([
-        ], TestModel::withSchemalessAttributes('name', 'non-existing-value')->get());
+            $model1, $model2,
+        ], TestModel::withSchemalessAttributes('name2', '!=', 'value3')->get());
+
+        $this->assertContainsModels([
+            $model3,
+        ], TestModel::withSchemalessAttributes('arr->subKey1', 'subVal2')->get());
+
+        $this->assertContainsModels([
+            $model1, $model2,
+        ], TestModel::withSchemalessAttributes('arr->subKey1', '!=', 'subVal2')->get());
 
         $this->assertContainsModels([
         ], TestModel::withSchemalessAttributes('name', 'non-existing-value')->get());