Support expr in queries

lib/Doctrine/ODM/MongoDB/Aggregation/Builder.php

@@ -160,6 +160,14 @@ public function count(string $fieldName): Stage\Count
         return $stage;
     }
 
+    /**
+     * Create a new Expr instance that can be used as an expression with the Builder
+     */
+    public function createAggregationExpression(): Expr
+    {
+        return new Expr($this->dm, $this->class);
+    }
+
     /**
      * Executes the aggregation pipeline
      *
@@ -180,9 +188,20 @@ public function execute(array $options = []): Iterator
         return $this->getAggregation($options)->getIterator();
     }
 
+    /**
+     * @deprecated use createAggregationExpression instead
+     */
     public function expr(): Expr
     {
-        return new Expr($this->dm, $this->class);
+        trigger_deprecation(
+            'doctrine/mongodb-odm',
+            '2.5',
+            'The "%s" method is deprecated. Please use "%s::createAggregationExpression" instead.',
+            __METHOD__,
+            static::class
+        );
+
+        return $this->createAggregationExpression();
     }
 
     /**

lib/Doctrine/ODM/MongoDB/Aggregation/Expr.php

@@ -19,6 +19,7 @@
 use function is_array;
 use function is_string;
 use function substr;
+use function trigger_deprecation;
 
 /**
  * Fluent interface for building aggregation pipelines.
@@ -324,6 +325,16 @@ public static function convertExpression($expression)
         return $expression;
     }
 
+    /**
+     * Returns a new expression object
+     *
+     * @return static
+     */
+    public function createAggregationExpression(): self
+    {
+        return new static($this->dm, $this->class);
+    }
+
     /**
      * Converts a date object to a string according to a user-specified format.
      *
@@ -453,10 +464,20 @@ public function exp($exponent): self
 
     /**
      * Returns a new expression object
+     *
+     * @deprecated use createAggregationExpression instead
      */
     public function expr(): self
     {
-        return new static($this->dm, $this->class);
+        trigger_deprecation(
+            'doctrine/mongodb-odm',
+            '2.5',
+            'The "%s" method is deprecated. Please use "%s::createAggregationExpression" instead.',
+            __METHOD__,
+            static::class
+        );
+
+        return $this->createAggregationExpression();
     }
 
     /**
@@ -1098,6 +1119,20 @@ public function reduce($input, $initialValue, $in): self
         return $this->operator('$reduce', ['input' => $input, 'initialValue' => $initialValue, 'in' => $in]);
     }
 
+    /**
+     * Performs a regular expression (regex) pattern matching
+     *
+     * @see https://docs.mongodb.com/manual/reference/operator/aggregation/regexMatch/
+     *
+     * @param mixed|self $input   The value to compare. (Use "$<field>" format to test your regex on a field)
+     * @param mixed|self $regex   The regular expression (regex)
+     * @param mixed|self $options A string containing regex flags options. See mongodb doc. above for details
+     */
+    public function regexMatch($input, $regex, $options): self
+    {
+        return $this->operator('$regexMatch', ['input' => $input, 'regex' => $regex, 'options' => $options]);
+    }
+
     /**
      * Accepts an array expression as an argument and returns an array with the
      * elements in reverse order.

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Bucket/AbstractOutput.php

@@ -25,7 +25,7 @@ public function __construct(Builder $builder, Stage\AbstractBucket $bucket)
         parent::__construct($builder);
 
         $this->bucket = $bucket;
-        $this->expr   = $builder->expr();
+        $this->expr   = $builder->createAggregationExpression();
     }
 
     public function getExpression(): array

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Group.php

@@ -19,7 +19,7 @@ public function __construct(Builder $builder)
     {
         parent::__construct($builder);
 
-        $this->expr = $builder->expr();
+        $this->expr = $builder->createAggregationExpression();
     }
 
     public function getExpression(): array

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/MatchStage.php

@@ -4,12 +4,14 @@
 
 namespace Doctrine\ODM\MongoDB\Aggregation\Stage;
 
+use Doctrine\ODM\MongoDB\Aggregation;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Doctrine\ODM\MongoDB\Aggregation\Stage;
 use Doctrine\ODM\MongoDB\Query\Expr;
 use GeoJson\Geometry\Geometry;
 
 use function func_get_args;
+use function trigger_deprecation;
 
 /**
  * Fluent interface for building aggregation pipelines.
@@ -23,7 +25,7 @@ public function __construct(Builder $builder)
     {
         parent::__construct($builder);
 
-        $this->query = $this->expr();
+        $this->query = $this->createQueryExpression();
     }
 
     /**
@@ -114,6 +116,15 @@ public function all(array $values): self
         return $this;
     }
 
+    /**
+     * Create a new Expr instance that can be used to build partial expressions
+     * for other operator methods.
+     */
+    public function createQueryExpression(): Expr
+    {
+        return $this->builder->matchExpr();
+    }
+
     /**
      * Specify $elemMatch criteria for the current field.
      *
@@ -166,12 +177,34 @@ public function exists(bool $bool): self
     }
 
     /**
-     * Create a new Expr instance that can be used to build partial expressions
-     * for other operator methods.
+     * @deprecated use createExpr instead
      */
     public function expr(): Expr
     {
-        return $this->builder->matchExpr();
+        trigger_deprecation(
+            'doctrine/mongodb-odm',
+            '2.5',
+            'The "%s" method is deprecated. Please use "%s::createQueryExpression" instead.',
+            __METHOD__,
+            static::class
+        );
+
+        return $this->createQueryExpression();
+    }
+
+    /**
+     * Specify $expr criteria for the current field.
+     *
+     * @see https://docs.mongodb.com/manual/reference/operator/query/expr/
+     * @see Expr::aggregationExpression()
+     *
+     * @param array|Aggregation\Expr $expression
+     */
+    public function aggregationExpression($expression): self
+    {
+        $this->query->aggregationExpression($expression);
+
+        return $this;
     }
 
     /**

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Operator.php

@@ -27,7 +27,7 @@ public function __construct(Builder $builder)
     {
         parent::__construct($builder);
 
-        $this->expr = $builder->expr();
+        $this->expr = $builder->createAggregationExpression();
     }
 
     /**

lib/Doctrine/ODM/MongoDB/Configuration.php

@@ -104,7 +104,8 @@ class Configuration
      *      persistentCollectionGenerator?: PersistentCollectionGenerator,
      *      persistentCollectionDir?: string,
      *      persistentCollectionNamespace?: string,
-     *      repositoryFactory?: RepositoryFactory
+     *      repositoryFactory?: RepositoryFactory,
+     *      writeConcern?: WriteConcern
      * }
      */
     private array $attributes = [];

lib/Doctrine/ODM/MongoDB/DocumentManager.php

@@ -284,7 +284,6 @@ public function getClassNameResolver(): ClassNameResolver
      * @psalm-return ClassMetadata<T>
      *
      * @template T of object
-     *
      * @psalm-suppress InvalidReturnType, InvalidReturnStatement see https://github.com/vimeo/psalm/issues/5788
      */
     public function getClassMetadata($className): ClassMetadata

lib/Doctrine/ODM/MongoDB/Iterator/CachingIterator.php

@@ -6,7 +6,6 @@
 
 use Countable;
 use Generator;
-use ReturnTypeWillChange;
 use RuntimeException;
 use Traversable;
 
@@ -80,7 +79,7 @@ public function toArray(): array
     /**
      * @return TValue|false
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return current($this->items);
@@ -89,7 +88,7 @@ public function current()
     /**
      * @return mixed
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return key($this->items);

lib/Doctrine/ODM/MongoDB/Iterator/HydratingIterator.php

@@ -8,7 +8,6 @@
 use Doctrine\ODM\MongoDB\UnitOfWork;
 use Generator;
 use Iterator;
-use ReturnTypeWillChange;
 use RuntimeException;
 use Traversable;
 
@@ -60,7 +59,7 @@ public function __destruct()
     /**
      * @return TDocument|null
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->hydrate($this->getIterator()->current());
@@ -69,7 +68,7 @@ public function current()
     /**
      * @return mixed
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->getIterator()->key();

lib/Doctrine/ODM/MongoDB/Iterator/PrimingIterator.php

@@ -7,7 +7,6 @@
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Query\ReferencePrimer;
 use Doctrine\ODM\MongoDB\UnitOfWork;
-use ReturnTypeWillChange;
 
 use function is_callable;
 use function iterator_to_array;
@@ -62,7 +61,7 @@ public function toArray(): array
     /**
      * @return TValue|null
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function current()
     {
         $this->primeReferences();
@@ -78,7 +77,7 @@ public function next(): void
     /**
      * @return mixed
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->iterator->key();

lib/Doctrine/ODM/MongoDB/Iterator/UnrewindableIterator.php

@@ -6,7 +6,6 @@
 
 use Generator;
 use LogicException;
-use ReturnTypeWillChange;
 use RuntimeException;
 use Traversable;
 
@@ -61,7 +60,7 @@ public function toArray(): array
     /**
      * @return TValue|null
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->getIterator()->current();
@@ -70,7 +69,7 @@ public function current()
     /**
      * @return mixed
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function key()
     {
         if ($this->iterator) {

lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php

@@ -12,7 +12,6 @@
 use Doctrine\ODM\MongoDB\MongoDBException;
 use Doctrine\ODM\MongoDB\UnitOfWork;
 use Doctrine\ODM\MongoDB\Utility\CollectionHelper;
-use ReturnTypeWillChange;
 use Traversable;
 
 use function array_combine;
@@ -410,7 +409,7 @@ public function getValues()
     /**
      * @return int
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function count()
     {
         // Workaround around not being able to directly count inverse collections anymore
@@ -438,7 +437,7 @@ public function isEmpty()
      * @return Traversable
      * @psalm-return Traversable<TKey, T>
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         $this->initialize();
@@ -537,7 +536,7 @@ public function __sleep()
      *
      * @return bool
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         $this->initialize();
@@ -551,7 +550,7 @@ public function offsetExists($offset)
      * @return mixed
      * @psalm-return T|null
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         $this->initialize();
@@ -565,7 +564,7 @@ public function offsetGet($offset)
      *
      * @return void
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if (! isset($offset)) {
@@ -582,7 +581,7 @@ public function offsetSet($offset, $value)
      *
      * @return void
      */
-    #[ReturnTypeWillChange]
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $this->doRemove($offset, true);