FilterEmpty
extends SearchFilter
in package
Search filter object
This is the is empty filter.
Tags
Table of Contents
- $empty : bool
- Allow empty
- $field : mixed
- $is_or : bool
- Is or filter
- $value : mixed
- __construct() : mixed
- FilterEmpty constructor.
- Field() : mixed
- Get the filed
- IsOr() : bool
- Is or connection?
- ToQuery() : string
- To query Convert the search filter instance to search query string
- ToSqlQuery() : SqlTerm|array<string|int, SqlTerm>|null
- Create a sql query based on this filter
- value() : mixed
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
Methods
__construct()
FilterEmpty constructor.
public
__construct(string $field[, bool $is_or = false ]) : mixed
Parameters
- $field : string
-
The field to search for
- $is_or : bool = false
-
Is an or connect
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()
To query Convert the search filter instance to search query string
public
ToQuery() : string
Return values
string —ToSqlQuery()
Create a sql query based on this filter
public
ToSqlQuery() : SqlTerm|array<string|int, SqlTerm>|null
Tags
Return values
SqlTerm|array<string|int, SqlTerm>|null —value()
protected
value(mixed $entity) : mixed
Parameters
- $entity : mixed