FilterHigher
extends SearchFilter
in package
Class FilterHigher
Filters by higher or, higher and equal
Table of Contents
- $empty : bool
- Allow empty
- $field : mixed
- $is_or : bool
- Is or filter
- $value : mixed
- $or_equal : bool
- __construct() : mixed
- Filter higher constructor.
- Field() : mixed
- Get the filed
- IsOr() : bool
- Is or connection?
- ToQuery() : string
- Create query
- ToSqlQuery() : SqlTerm|array<string|int, SqlTerm>|null
- Create a sql query based on this filter
Properties
$empty
Allow empty
protected
bool
$empty
= false
$field
protected
mixed
$field
$is_or
Is or filter
protected
bool
$is_or
= false
$value
protected
mixed
$value
$or_equal
private
bool
$or_equal
Methods
__construct()
Filter higher constructor.
public
__construct(string $field, scalar $value[, bool $or_equal = false ][, bool $is_or = false ][, bool $empty = false ]) : mixed
A higher filter with field and option to be equal
Parameters
- $field : string
-
Name of the search field
- $value : scalar
-
The search value
- $or_equal : bool = false
-
Enable is lower or equal
- $is_or : bool = false
-
Merge with other filters with or
- $empty : bool = false
-
Allow empty
Return values
mixed —Field()
Get the filed
public
Field() : mixed
Return values
mixed —IsOr()
Is or connection?
public
IsOr() : bool
When merged with other filter use OR instead of AND
Return values
bool —Is or merge
ToQuery()
Create query
public
ToQuery() : string
Convert to solr search query like length:[1 TO *] for all above 0 In numeric cases it will increase the given value by one
Return values
string —The search query
ToSqlQuery()
Create a sql query based on this filter
public
ToSqlQuery() : SqlTerm|array<string|int, SqlTerm>|null