mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-07-01 00:49:33 +02:00
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
title: SearchFilter Modifiers
|
|
summary: Use suffixes on your ORM queries.
|
|
|
|
# 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.
|
|
|
|
* [api:StartsWithFilter]
|
|
* [api:EndsWithFilter]
|
|
* [api:PartialMatchFilter]
|
|
* [api:GreaterThanFilter]
|
|
* [api:GreaterThanOrEqualFilter]
|
|
* [api:LessThanFilter]
|
|
* [api:LessThanOrEqualFilter]
|
|
|
|
An example of a `SearchFilter` in use:
|
|
|
|
:::php
|
|
// 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 [api: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.
|
|
|
|
The following is a query which will return everyone whose first name starts with "S", either lowercase or uppercase:
|
|
|
|
:::php
|
|
$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
|
|
|
|
* [api:SearchFilter] |