FilterDefinition
in package
Filter definition
Describe filter attributes
Tags
Table of Contents
Constants
- TYPE_BOOL = 'bool'
- TYPE_DATETIME = 'datetime'
- TYPE_FLOAT = 'float'
- TYPE_INT = 'int'
- TYPE_NC_GROUP = 'nc-group'
- TYPE_NC_USER = 'nc-user'
- TYPE_PERSON = 'person'
- TYPE_STRING = 'string'
- TYPE_STRINGS = 'strings'
Properties
- $exclusive : bool
- $name : string
- $type : string
Methods
- __construct() : mixed
- Build filter definition
- exclusive() : bool
- Is filter exclusive?
- name() : string
- Filter name
- type() : self::TYPE_*
- Filter type
Constants
TYPE_BOOL
public
mixed
TYPE_BOOL
= 'bool'
Tags
TYPE_DATETIME
public
mixed
TYPE_DATETIME
= 'datetime'
Tags
TYPE_FLOAT
public
mixed
TYPE_FLOAT
= 'float'
Tags
TYPE_INT
public
mixed
TYPE_INT
= 'int'
Tags
TYPE_NC_GROUP
public
mixed
TYPE_NC_GROUP
= 'nc-group'
Tags
TYPE_NC_USER
public
mixed
TYPE_NC_USER
= 'nc-user'
Tags
TYPE_PERSON
public
mixed
TYPE_PERSON
= 'person'
Tags
TYPE_STRING
public
mixed
TYPE_STRING
= 'string'
Tags
TYPE_STRINGS
public
mixed
TYPE_STRINGS
= 'strings'
Tags
Properties
$exclusive
private
bool
$exclusive
= true
$name
private
string
$name
$type
private
string
$type
= self::TYPE_STRING
Methods
__construct()
Build filter definition
public
__construct(string $name[, self::TYPE_* $type = self::TYPE_STRING ][, bool $exclusive = true ]) : mixed
Parameters
- $name : string
- $type : self::TYPE_* = self::TYPE_STRING
- $exclusive : bool = true
-
If true, all providers not supporting this filter will be ignored when this filter is provided
Tags
exclusive()
Is filter exclusive?
public
exclusive() : bool
If exclusive, only provider with support for this filter will receive the query.
Example: if an exclusive filter mimetype is declared, a search with this term will not
be send to providers like settings that doesn't support it.
Tags
Return values
boolname()
Filter name
public
name() : string
Name is used in query string and for advanced syntax name: <value>
Tags
Return values
stringtype()
Filter type
public
type() : self::TYPE_*
Expected type of value for the filter