feat: add toggle to disableEmulatorNullFilteredIndexCheck for ease of use (#286)

Author: taka-oyama

src/Query/Builder.php

@@ -268,9 +268,10 @@ public function forceIndex($index): static
     }
 
     /**
+     * @param bool $toggle  checking disabled when true, enabled when false
      * @return $this
      */
-    public function disableEmulatorNullFilteredIndexCheck(): static
+    public function disableEmulatorNullFilteredIndexCheck(bool $toggle = true): static
     {
         $indexHint = $this->indexHint;
 
@@ -279,7 +280,7 @@ public function disableEmulatorNullFilteredIndexCheck(): static
         }
 
         assert($indexHint instanceof IndexHint);
-        $indexHint->disableEmulatorNullFilteredIndexCheck = true;
+        $indexHint->disableEmulatorNullFilteredIndexCheck = $toggle;
 
         return $this;
     }

tests/Query/BuilderTest.php

@@ -474,6 +474,32 @@ public function test_disableEmulatorNullFilteredIndexCheck(): void
         $this->assertSame([], $qb->get()->all());
     }
 
+    public function test_disableEmulatorNullFilteredIndexCheck_with_toggle_as_true(): void
+    {
+        $conn = $this->getDefaultConnection();
+        $tableName = 'Test';
+
+        $qb = $conn->table($tableName)
+            ->forceIndex('test_index_name')
+            ->disableEmulatorNullFilteredIndexCheck(true);
+
+        $hint = '@{FORCE_INDEX=test_index_name,spanner_emulator.disable_query_null_filtered_index_check=true}';
+        $this->assertSame("select * from `{$tableName}` {$hint}", $qb->toSql());
+    }
+
+    public function test_disableEmulatorNullFilteredIndexCheck_with_toggle_as_false(): void
+    {
+        $conn = $this->getDefaultConnection();
+        $tableName = 'Test';
+
+        $qb = $conn->table($tableName)
+            ->forceIndex('test_index_name')
+            ->disableEmulatorNullFilteredIndexCheck(false);
+
+        $hint = '@{FORCE_INDEX=test_index_name}';
+        $this->assertSame("select * from `{$tableName}` {$hint}", $qb->toSql());
+    }
+
     public function test_disableEmulatorNullFilteredIndexCheck_without_calling_force_index(): void
     {
         $this->expectExceptionMessage('Force index must be set before disabling null filter index check');