FulltextFilter
class FulltextFilter extends SearchFilter (View source)
Filters by full-text matching on the given field.
The following column types are supported:
- Char
- Varchar
- Text
To enable full-text matching on fields, you also need to add an index to the database table, using the {$indexes} hash in your DataObject subclass:
private static $indexes = [
'SearchFields' => [
'type' => 'fulltext',
'columns' => ['Name', 'Title', 'Description'],
];Traits
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Config options
| default_case_sensitive | bool|null | Whether search filters should be case sensitive or not by default. |
from SearchFilter |
Properties
| protected | string | $model | Classname of the inspected DataObject. |
from SearchFilter |
| protected | string | $name | from SearchFilter | |
| protected | string | $fullName | from SearchFilter | |
| protected | mixed | $value | from SearchFilter | |
| protected | array | $modifiers | from SearchFilter | |
| protected | array | $relation | from SearchFilter | |
| protected | array | $aggregate | An array of data about an aggregate column being used ex: [ 'function' => 'COUNT', 'column' => 'ID' ] |
from SearchFilter |
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.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
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.
Set the current modifiers to apply to the filter
Accessor for the current modifiers to apply to the filter.
The full name passed to the constructor, including any (optional) relations in dot notation.
This implementation allows for a list of columns to be passed into MATCH() instead of just one.
Return the value of the field as processed by the DBField class
Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause
Check whether this filter matches against a value.
Determines case sensitivity based on getModifiers().
Find out whether the database is set to use case sensitive comparisons or not by default.
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).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
__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()
This implementation allows for a list of columns to be passed into MATCH() instead of just one.
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
bool
matches(mixed $objectValue)
Check whether this filter matches against a value.
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.
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 ?bool
getCaseSensitive()
Determines case sensitivity based on getModifiers().
protected bool|null
getCaseSensitiveByCollation()
Find out whether the database is set to use case sensitive comparisons or not by default.
Used for static comparisons in the matches() method.
protected string
prepareColumns(array $columns)
Adds table identifier to the every column.
Columns must have table identifier to prevent duplicate column name error.