class LessThanFilter extends ComparisonFilter (View source)

Selects numerical/date content less than the input

Can be used by SearchContext and DataList->filter, eg; Model::get()->filter("Field1:LessThan", $value);

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

__construct(string $fullName = null, mixed $value = false, array $modifiers = [])

No description

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

applyAggregate(DataQuery $query, string $having)

Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause

apply(DataQuery $query)

Apply filter criteria to a SQL query.

exclude(DataQuery $query)

Exclude filter criteria from a SQL query.

bool
isEmpty()

Determines if a field has a value, and that the filter should be applied.

Details

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(string $fullName = null, mixed $value = false, array $modifiers = [])

Parameters

string $fullName

Determines the name of the field, as well as the searched database column. Can contain a relation name in dot notation, which will automatically join the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and search the "Name" column when applying this filter to a SiteTree class).

mixed $value
array $modifiers

setModel(string|DataObject $className)

Set the root model class to be selected by this search query.

Parameters

string|DataObject $className

setValue(string|array $value)

Set the current value(s) to be filtered on.

Parameters

string|array $value

string|array getValue()

Accessor for the current value to be filtered on.

Return Value

string|array

setModifiers(array $modifiers)

Set the current modifiers to apply to the filter

Parameters

array $modifiers

array getSupportedModifiers()

Gets supported modifiers for this filter

Return Value

array

array getModifiers()

Accessor for the current modifiers to apply to the filter.

Return Value

array

string getName()

The original name of the field.

Return Value

string

setName(string $name)

Parameters

string $name

string getFullName()

The full name passed to the constructor, including any (optional) relations in dot notation.

Return Value

string

setFullName(string $name)

Parameters

string $name

string getDbName()

Normalizes the field name to table mapping.

Return Value

string

string getDbFormattedValue()

Return the value of the field as processed by the DBField class

Return Value

string

DataQuery applyAggregate(DataQuery $query, string $having)

Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause

Parameters

DataQuery $query
string $having

Return Value

DataQuery

DataQuery apply(DataQuery $query)

Apply filter criteria to a SQL query.

Parameters

DataQuery $query

Return Value

DataQuery

DataQuery exclude(DataQuery $query)

Exclude filter criteria from a SQL query.

Parameters

DataQuery $query

Return Value

DataQuery

bool isEmpty()

Determines if a field has a value, and that the filter should be applied.

Relies on the field being populated with {@link setValue()}

Return Value

bool