Add better bitwise operators support

Author: Marc-Etienne Barrut

src/Illuminate/Database/Query/Builder.php

@@ -203,6 +203,15 @@ class Builder
         'not similar to', 'not ilike', '~~*', '!~~*',
     ];
 
+    /**
+     * All of the available binary operators.
+     *
+     * @var string[]
+     */
+    public $binaryOperators = [
+        '&', '|', '^', '<<', '>>', '&~',
+    ];
+
     /**
      * Whether to use write pdo for the select.
      *
@@ -754,6 +763,10 @@ public function where($column, $operator = null, $value = null, $boolean = 'and'
             }
         }
 
+        if ($this->isBinaryOperator($operator)) {
+            $type = 'Binary';
+        }
+
         // Now that we are working with just a simple query we can put the elements
         // in our array and add the query binding to our array of bindings that
         // will be bound to each SQL statements when it is finally executed.
@@ -837,6 +850,12 @@ protected function invalidOperator($operator)
                ! in_array(strtolower($operator), $this->grammar->getOperators(), true);
     }
 
+    protected function isBinaryOperator($operator)
+    {
+        return in_array(strtolower($operator), $this->binaryOperators, true) ||
+               in_array(strtolower($operator), $this->grammar->getBinaryOperators(), true);
+    }
+
     /**
      * Add an "or where" clause to the query.
      *
@@ -1915,6 +1934,10 @@ public function having($column, $operator = null, $value = null, $boolean = 'and
             [$value, $operator] = [$operator, '='];
         }
 
+        if ($this->isBinaryOperator($operator)) {
+            $type = 'binary';
+        }
+
         $this->havings[] = compact('type', 'column', 'operator', 'value', 'boolean');
 
         if (! $value instanceof Expression) {

src/Illuminate/Database/Query/Grammars/Grammar.php

@@ -18,6 +18,13 @@ class Grammar extends BaseGrammar
      */
     protected $operators = [];
 
+    /**
+     * The grammar specific binary operators.
+     *
+     * @var array
+     */
+    protected $binaryOperators = [];
+
     /**
      * The components that make up a select clause.
      *
@@ -255,6 +262,15 @@ protected function whereBasic(Builder $query, $where)
         return $this->wrap($where['column']).' '.$operator.' '.$value;
     }
 
+    protected function whereBinary(Builder $query, $where)
+    {
+        $value = $this->parameter($where['value']);
+
+        $operator = str_replace('?', '??', $where['operator']);
+
+        return '('.$this->wrap($where['column']).' '.$operator.' '.$value.') != 0';
+    }
+
     /**
      * Compile a "where in" clause.
      *
@@ -571,7 +587,8 @@ protected function whereJsonContains(Builder $query, $where)
         $not = $where['not'] ? 'not ' : '';
 
         return $not.$this->compileJsonContains(
-            $where['column'], $this->parameter($where['value'])
+            $where['column'],
+            $this->parameter($where['value'])
         );
     }
 
@@ -610,7 +627,9 @@ public function prepareBindingForJsonContains($binding)
     protected function whereJsonLength(Builder $query, $where)
     {
         return $this->compileJsonLength(
-            $where['column'], $where['operator'], $this->parameter($where['value'])
+            $where['column'],
+            $where['operator'],
+            $this->parameter($where['value'])
         );
     }
 
@@ -682,6 +701,8 @@ protected function compileHaving(array $having)
             return $having['boolean'].' '.$having['sql'];
         } elseif ($having['type'] === 'between') {
             return $this->compileHavingBetween($having);
+        } elseif ($having['type'] === 'binary') {
+            return $this->compileHavingBinary($having);
         }
 
         return $this->compileBasicHaving($having);
@@ -721,6 +742,21 @@ protected function compileHavingBetween($having)
         return $having['boolean'].' '.$column.' '.$between.' '.$min.' and '.$max;
     }
 
+    /**
+     * Compile a having clause involving a binary operator.
+     *
+     * @param  array  $having
+     * @return string
+     */
+    protected function compileHavingBinary($having)
+    {
+        $column = $this->wrap($having['column']);
+
+        $parameter = $this->parameter($having['value']);
+
+        return $having['boolean'].' ('.$column.' '.$having['operator'].' '.$parameter.') != 0';
+    }
+
     /**
      * Compile the "order by" portions of the query.
      *
@@ -1296,4 +1332,14 @@ public function getOperators()
     {
         return $this->operators;
     }
+
+    /**
+     * Get the grammar specific binary operators.
+     *
+     * @return array
+     */
+    public function getBinaryOperators()
+    {
+        return $this->binaryOperators;
+    }
 }

src/Illuminate/Database/Query/Grammars/PostgresGrammar.php

@@ -21,6 +21,15 @@ class PostgresGrammar extends Grammar
         'is distinct from', 'is not distinct from',
     ];
 
+    /**
+     * The grammar specific binary operators.
+     *
+     * @var array
+     */
+    protected $binaryOperators = [
+        '~', '&', '|', '#', '<<', '>>', '<<=', '>>=',
+    ];
+
     /**
      * {@inheritdoc}
      *

tests/Database/DatabaseQueryBuilderTest.php

@@ -3209,6 +3209,25 @@ public function testMySqlSoundsLikeOperator()
         $this->assertEquals(['John Doe'], $builder->getBindings());
     }
 
+    public function testBinaryOperators()
+    {
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')->where('bar', '&', 1);
+        $this->assertSame('select * from "users" where ("bar" & ?) != 0', $builder->toSql());
+
+        $builder = $this->getPostgresBuilder();
+        $builder->select('*')->from('users')->where('bar', '#', 1);
+        $this->assertSame('select * from "users" where ("bar" # ?) != 0', $builder->toSql());
+
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')->having('bar', '&', 1);
+        $this->assertSame('select * from "users" having ("bar" & ?) != 0', $builder->toSql());
+
+        $builder = $this->getPostgresBuilder();
+        $builder->select('*')->from('users')->having('bar', '#', 1);
+        $this->assertSame('select * from "users" having ("bar" # ?) != 0', $builder->toSql());
+    }
+
     public function testMergeWheresCanMergeWheresAndBindings()
     {
         $builder = $this->getBuilder();