Add regex type

nebkam · Aug 8, 2023 · 7e9c06b · 7e9c06b
1 parent fec88ae
commit 7e9c06b
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 1 deletion.
diff --git a/src/SearchParam.php b/src/SearchParam.php
@@ -12,7 +12,8 @@ public function __construct(
 		public ?SearchParamDirection $direction = null,
 		public ?string               $field = null,
 		public ?array                $callable = null,
-		public ?bool                 $invert = null
+		public ?bool                 $invert = null,
+		public ?string               $flags = null
 	)
 		{
 		}

diff --git a/src/SearchParamParser.php b/src/SearchParamParser.php
@@ -6,6 +6,7 @@
 use Doctrine\ODM\MongoDB\Query\Builder;
 use IntBackedEnum;
 use InvalidArgumentException;
+use MongoDB\BSON\Regex;
 use ReflectionClass;
 use ReflectionException;
 use StringBackedEnum;
@@ -47,6 +48,7 @@ public static function parse($filter, Builder|MatchStage $builder): void
 							SearchParamType::RangeFloat => self::setRangeFloat($attribute, $builder, $field, $value),
 							SearchParamType::RangeInt => self::setRangeInt($attribute, $builder, $field, $value),
 							SearchParamType::RangeIntEnum => self::setRangeIntEnum($attribute, $builder, $field, $value),
+							SearchParamType::Regex => self::setRegex($attribute, $builder, $field, $value),
 							SearchParamType::String => self::setString($attribute, $builder, $field, $value),
 							SearchParamType::StringArray => self::setStringArray($attribute, $builder, $field, $value),
 							SearchParamType::StringEnum => self::setStringEnum($attribute, $builder, $field, $value),
@@ -197,6 +199,14 @@ private static function setRangeIntEnum(SearchParam $attribute, Builder|MatchSta
 			: $builder->field($field)->lte((int)$value->value);
 		}
 
+	private static function setRegex(SearchParam $attribute, Builder|MatchStage $builder, string $field, mixed $value): void
+		{
+		if ($value)
+			{
+			$builder->field($field)->equals(new Regex($value, $attribute->flags ?? ''));
+			}
+		}
+
 	private static function setString(SearchParam $attribute, Builder|MatchStage $builder, string $field, $value): void
 		{
 		if ($attribute->invert)

diff --git a/src/SearchParamType.php b/src/SearchParamType.php
@@ -16,6 +16,7 @@ enum SearchParamType
 	case RangeFloat;
 	case RangeInt;
 	case RangeIntEnum;
+	case Regex;
 	case String;
 	case StringArray;
 	case StringEnum;

diff --git a/tests/SearchFilter.php b/tests/SearchFilter.php
@@ -63,6 +63,9 @@ class SearchFilter
 	#[SearchParam(type: SearchParamType::RangeIntEnum, direction: SearchParamDirection::To)]
 	public ?IntEnum $rangeIntEnumToProperty = null;
 
+	#[SearchParam(type: SearchParamType::Regex, flags: 'i')]
+	public ?string $regexProperty = null;
+
 	#[SearchParam(type: SearchParamType::String)]
 	public ?string $stringProperty = null;
 

diff --git a/tests/SearchParamTest.php b/tests/SearchParamTest.php
@@ -3,6 +3,7 @@
 namespace Nebkam\OdmSearchParam\Tests;
 
 use DateTime;
+use MongoDB\BSON\Regex;
 use MongoDB\BSON\UTCDateTime;
 use Nebkam\OdmSearchParam\SearchParamParser;
 use Nebkam\OdmSearchParam\Tests\Documents\SearchableDocument;
@@ -333,6 +334,22 @@ public function testRangeEnumIntTo(): void
 		self::assertBuiltMatchStageEquals($matchStage, ['rangeIntEnumToProperty' => ['$lte' => IntEnum::FOO->value]]);
 		}
 
+	/**
+	 * @throws ReflectionException
+	 */
+	public function testRegex(): void
+		{
+		$filter                 = new SearchFilter();
+		$filter->regexProperty = 'foo';
+		$queryBuilder           = self::createTestQueryBuilder(SearchableDocument::class);
+		$matchStage             = self::createTestAggregationBuilder(SearchableDocument::class)->match();
+
+		SearchParamParser::parse($filter, $queryBuilder);
+		SearchParamParser::parse($filter, $matchStage);
+		self::assertEquals(new Regex('foo', 'i'), $queryBuilder->getQuery()->debug()['query']['regexProperty']);
+		self::assertEquals(new Regex('foo', 'i'), $matchStage->getExpression()['$match']['regexProperty']);
+		}
+
 	/**
 	 * @throws ReflectionException
 	 */