Allow for custom Postgres operators to be added (#53324)

* Allow for custom Postgres operators to be added * formatting --------- Co-authored-by: Taylor Otwell <taylor@laravel.com>
laravel · Oct 29, 2024 · 029e993 · 029e993
1 parent 0f835f6
commit 029e993
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/src/Illuminate/Database/Query/Grammars/PostgresGrammar.php b/src/Illuminate/Database/Query/Grammars/PostgresGrammar.php
@@ -22,6 +22,13 @@ class PostgresGrammar extends Grammar
         'is distinct from', 'is not distinct from',
     ];
 
+    /**
+     * The Postgres grammar specific custom operators.
+     *
+     * @var array
+     */
+    protected static $customOperators = [];
+
     /**
      * The grammar specific bitwise operators.
      *
@@ -772,4 +779,27 @@ public function substituteBindingsIntoRawSql($sql, $bindings)
 
         return $query;
     }
+
+    /**
+     * Get the Postgres grammar specific operators.
+     *
+     * @return array
+     */
+    public function getOperators()
+    {
+        return array_values(array_unique(array_merge(parent::getOperators(), static::$customOperators)));
+    }
+
+    /**
+     * Set any Postgres grammar specific custom operators.
+     *
+     * @param  array  $operators
+     * @return void
+     */
+    public static function customOperators(array $operators)
+    {
+        static::$customOperators = array_values(
+            array_merge(static::$customOperators, array_filter(array_filter($operators, 'is_string')))
+        );
+    }
 }
diff --git a/tests/Database/DatabasePostgresQueryGrammarTest.php b/tests/Database/DatabasePostgresQueryGrammarTest.php
@@ -28,4 +28,23 @@ public function testToRawSql()
 
         $this->assertSame('select * from "users" where \'{}\' ? \'Hello\\\'\\\'World?\' AND "email" = \'foo\'', $query);
     }
+
+    public function testCustomOperators()
+    {
+        PostgresGrammar::customOperators(['@@@', '@>', '']);
+        PostgresGrammar::customOperators(['@@>', 1]);
+
+        $connection = m::mock(Connection::class);
+        $grammar = new PostgresGrammar;
+        $grammar->setConnection($connection);
+
+        $operators = $grammar->getOperators();
+
+        $this->assertIsList($operators);
+        $this->assertContains('@@@', $operators);
+        $this->assertContains('@@>', $operators);
+        $this->assertNotContains('', $operators);
+        $this->assertNotContains(1, $operators);
+        $this->assertSame(array_unique($operators), $operators);
+    }
 }