This document contains information about a future release and not the current stable version (4). Be aware that information on this page may change and API's may not be stable for production use.

SearchFilter Modifiers

The filter and exclude operations specify exact matches by default. However, there are a number of suffixes that you can put on field names to change this behavior. These are represented as SearchFilter subclasses and include.

An example of a SearchFilter in use:

// fetch any player that starts with a S
$players = Player::get()->filter(array(
    'FirstName:StartsWith' => 'S',
    'PlayerNumber:GreaterThan' => '10'

// to fetch any player that's name contains the letter 'z'
$players = Player::get()->filterAny(array(
    'FirstName:PartialMatch' => 'z',
    'LastName:PartialMatch' => 'z'

Developers can define their own SearchFilter if needing to extend the ORM filter and exclude behaviors.

These suffixes can also take modifiers themselves. The modifiers currently supported are ":not", ":nocase" and ":case". These negate the filter, make it case-insensitive and make it case-sensitive, respectively. The default comparison uses the database's default. For MySQL and MSSQL, this is case-insensitive. For PostgreSQL, this is case-sensitive.

Note that all search filters (e.g. :PartialMatch) refer to services registered with Injector within the DataListFilter. prefixed namespace. New filters can be registered using the below yml config:

    class: MyVendor/Search/CustomMatchFilter

The following is a query which will return everyone whose first name starts with "S", either lowercase or uppercase:

$players = Player::get()->filter(array(
    'FirstName:StartsWith:nocase' => 'S'

// use :not to perform a converse operation to filter anything but a 'W'
$players = Player::get()->filter(array(
    'FirstName:StartsWith:not' => 'W'

API Documentation

Was this article helpful?