Add native bitwise operator support to Query Builder and Eloquent

MohsenEtemadi · MohsenEtemadi · commit 75ee96068e5e · 2025-08-30T11:01:45.000+03:30
[12.x] Add native bitwise operator support to Query Builder and Eloquent

fix: fix style ci
diff --git a/src/Illuminate/Database/Eloquent/Builder.php b/src/Illuminate/Database/Eloquent/Builder.php
@@ -407,6 +407,76 @@ public function orWhereNot($column, $operator = null, $value = null)
         return $this->whereNot($column, $operator, $value, 'or');
     }
 
+    /**
+     * Add a bitwise scope to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereBitwise($column, $value, $boolean = 'and')
+    {
+        $this->query->whereBitwise($column, $value, $boolean);
+
+        return $this;
+    }
+
+    /**
+     * Add a bitwise exact match scope to the query.
+     *
+     * @param  string  $column
+     * @param  int  $mask
+     * @param  int  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereBitwiseExact($column, $mask, $value, $boolean = 'and')
+    {
+        $this->query->whereBitwiseExact($column, $mask, $value, $boolean);
+
+        return $this;
+    }
+
+    /**
+     * Add an "or where bitwise" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @return $this
+     */
+    public function orWhereBitwise($column, $value)
+    {
+        return $this->whereBitwise($column, $value, 'or');
+    }
+
+    /**
+     * Add a "where not bitwise" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereNotBitwise($column, $value, $boolean = 'and')
+    {
+        $this->query->whereNotBitwise($column, $value, $boolean);
+
+        return $this;
+    }
+
+    /**
+     * Add an "or where not bitwise" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @return $this
+     */
+    public function orWhereNotBitwise($column, $value)
+    {
+        return $this->whereNotBitwise($column, $value, 'or');
+    }
+
     /**
      * Add an "order by" clause for a timestamp to the query.
      *
diff --git a/src/Illuminate/Database/Query/Builder.php b/src/Illuminate/Database/Query/Builder.php
@@ -2431,6 +2431,70 @@ public function orWhereNone($columns, $operator = null, $value = null)
         return $this->whereNone($columns, $operator, $value, 'or');
     }
 
+    /**
+     * Add a bitwise "AND" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereBitwise($column, $value, $boolean = 'and')
+    {
+        return $this->whereRaw("{$column} & ? > 0", [$value], $boolean);
+    }
+
+    /**
+     * Add a bitwise "AND" clause with exact match to the query.
+     *
+     * @param  string  $column
+     * @param  int  $mask
+     * @param  int  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereBitwiseExact($column, $mask, $value, $boolean = 'and')
+    {
+        return $this->whereRaw("({$column} & ?) = ?", [$mask, $value], $boolean);
+    }
+
+    /**
+     * Add a bitwise "OR" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @return $this
+     */
+    public function orWhereBitwise($column, $value)
+    {
+        return $this->whereBitwise($column, $value, 'or');
+    }
+
+    /**
+     * Add a bitwise "NOT" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereNotBitwise($column, $value, $boolean = 'and')
+    {
+        return $this->whereRaw("{$column} & ? = 0", [$value], $boolean);
+    }
+
+    /**
+     * Add a bitwise "OR NOT" clause to the query.
+     *
+     * @param  string  $column
+     * @param  int  $value
+     * @return $this
+     */
+    public function orWhereNotBitwise($column, $value)
+    {
+        return $this->whereNotBitwise($column, $value, 'or');
+    }
+
     /**
      * Add a "group by" clause to the query.
      *
diff --git a/tests/Database/DatabaseQueryBuilderTest.php b/tests/Database/DatabaseQueryBuilderTest.php
@@ -6893,6 +6893,40 @@ public function testWhereJsonLengthSqlServer()
         $this->assertEquals([1], $builder->getBindings());
     }
 
+    public function testWhereBitwise()
+    {
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')->whereBitwise('permissions', 4);
+        $this->assertSame('select * from "users" where permissions & ? > 0', $builder->toSql());
+        $this->assertEquals([4], $builder->getBindings());
+    }
+
+    public function testWhereBitwiseExact()
+    {
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')->whereBitwiseExact('permissions', 15, 15);
+        $this->assertSame('select * from "users" where (permissions & ?) = ?', $builder->toSql());
+        $this->assertEquals([15, 15], $builder->getBindings());
+    }
+
+    public function testOrWhereBitwise()
+    {
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')
+            ->whereBitwise('permissions', 1)
+            ->orWhereBitwise('permissions', 2);
+        $this->assertSame('select * from "users" where permissions & ? > 0 or permissions & ? > 0', $builder->toSql());
+        $this->assertEquals([1, 2], $builder->getBindings());
+    }
+
+    public function testWhereNotBitwise()
+    {
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')->whereNotBitwise('permissions', 4);
+        $this->assertSame('select * from "users" where permissions & ? = 0', $builder->toSql());
+        $this->assertEquals([4], $builder->getBindings());
+    }
+
     public function testFrom()
     {
         $builder = $this->getBuilder();
