SearchFilter
abstract class SearchFilter (View source)
Base class for filtering implementations, which work together with SearchContext to create or amend a query for DataObject instances.
See SearchContext for more information.
Each search filter must be registered in config as an "Injector" service with the "DataListFilter." prefix. E.g.
Injector:
DataListFilter.EndsWith:
class: EndsWithFilterTraits
A class that can be instantiated or replaced via DI
Properties
| protected | string | $model | Classname of the inspected DataObject. |
|
| protected | string | $name | ||
| protected | string | $fullName | ||
| protected | mixed | $value | ||
| protected | array | $modifiers | ||
| protected | array | $relation | ||
| protected | array | $aggregate | An array of data about an aggregate column being used ex: [ 'function' => 'COUNT', 'column' => 'ID' ] |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
No description
Called by constructor to convert a string pathname into a well defined relationship sequence.
Parses the name for any aggregate functions and stores them in the $aggregate array
Set the root model class to be selected by this search query.
The full name passed to the constructor, including any (optional) relations in dot notation.
Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
__construct(string $fullName = null, mixed $value = false, array $modifiers = [])
No description
protected
addRelation(string $name)
Called by constructor to convert a string pathname into a well defined relationship sequence.
protected
addAggregate(string $name)
Parses the name for any aggregate functions and stores them in the $aggregate array
setModel(string|DataObject $className)
Set the root model class to be selected by this search query.
setValue(string|array $value)
Set the current value(s) to be filtered on.
string|array
getValue()
Accessor for the current value to be filtered on.
setModifiers(array $modifiers)
Set the current modifiers to apply to the filter
array
getSupportedModifiers()
Gets supported modifiers for this filter
array
getModifiers()
Accessor for the current modifiers to apply to the filter.
string
getName()
The original name of the field.
setName(string $name)
No description
string
getFullName()
The full name passed to the constructor, including any (optional) relations in dot notation.
setFullName(string $name)
No description
string
getDbName()
Normalizes the field name to table mapping.
string
getDbFormattedValue()
Return the value of the field as processed by the DBField class
DataQuery
applyAggregate(DataQuery $query, string $having)
Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause
abstract protected DataQuery
applyOne(DataQuery $query)
Apply filter criteria to a SQL query with a single value.
protected DataQuery
applyMany(DataQuery $query)
Apply filter criteria to a SQL query with an array of values.
abstract protected DataQuery
excludeOne(DataQuery $query)
Exclude filter criteria from a SQL query with a single value.
protected DataQuery
excludeMany(DataQuery $query)
Exclude filter criteria from a SQL query with an array of values.
bool
isEmpty()
Determines if a field has a value, and that the filter should be applied.
Relies on the field being populated with setValue()
protected mixed
getCaseSensitive()
Determines case sensitivity based on getModifiers().