nebkam/odm-search-param

6.0.5 2023-08-08 14:29 UTC

Requires

• php: ^8.2
• ext-mongodb: ^1.15
• doctrine/mongodb-odm: ^2.5

Requires (Dev)

• phpunit/phpunit: ^10.0

MIT

README

Rationale

• you use Doctrine MongoDB ODM
• you need some search functionality, that can be expressed through the QueryBuilder or the MatchPhase of the Aggregation Builder
• you have a class that holds the search parameters (i.e. a domain class in Symfony)
• you don't want to manually map the search parameters to builder statements

Usage

1. Search filter class can be any class with public properties
2. Properties should be marked with #[SearchParam] attribute
3. Use the SearchParamParser::parse with a QueryBuilder|MatchStage instance to build the query on

Examples

Verbatim (String and Bool types)

class SearchFilter
{
    #[SearchParam(type: SearchParamType::String)]
    public string $name;
}

Builds the query to:

$builder->field('name')->equals($propertyValue);

Using different property names

class SearchFilter
{
    #[SearchParam(type: SearchParamType::Exists, field: 'images')]
    public bool $hasImages;
}

Builds the query to:

$builder->field('images')->exists(true);

Type casting (Int type)

class SearchFilter
{
    #[SearchParam(type: SearchParamType::Int)]
    public $age;
}

Builds the query to:

$builder->field('age')->equals((int) $propertyValue);

Type casting with arrays (IntArray and StringArray types)

class SearchFilter
{
    /**
    * @var int[] 
    */
    #[SearchParam(type: SearchParamType::IntArray)]
    public array $grades;
}

Builds the query to:

$builder->field('grades')->in($propertyValuesAllCastedToInt);

Using backing values from enums (StringEnum and IntEnum types)

class SearchFilter
{
    #[SearchParam(type: SearchParamType::StringEnum)]
    public SideOfTheWorldEnum $sideOfTheWorld;
}

Builds the query to:

$builder->field('sideOfTheWorld')->equals($propertyValue->value);

Using backing values from enum arrays (StringEnumArray and IntEnumArray types)

class SearchFilter
{
    /**
    * @var SideOfTheWorldEnum[]
    */
    #[SearchParam(type: SearchParamType::StringEnumArray)]
    public array $sidesOfTheWorld;
}

Builds the query to:

$builder->field('sideOfTheWorld')->in($backingValuesOfPropertyValue);

Querying by range (RangeInt, RangeInt and RangeFloat types)

class SearchFilter
{
    #[SearchParam(type: SearchParamType::RangeInt, direction: SearchParamDirection::From)]
    public int $price;
}

Builds the query to:

$builder->field('price')->gte((int) $propertyValue);

Custom query building by specifying the callable

class SearchFilter
{
    #[SearchParam(type: SearchParamType::Callable, callable: [SomeClass::class, 'setStatus'])]
    public string $status;
}

class SomeClass
{
    public static function setStatus(Builder|MatchStage $builder, $value, $filter)
    {
    // Call $builder methods to build the query
    }
}