IMP_Search_IteratorFilter
extends FilterIterator
in package
Iterator filter for the IMP_Search object.
Tags
Table of Contents
Constants
Properties
- $_mask : int
- Filtering mask.
Methods
- accept() : bool
- create() : IMP_Search_IteratorFilter
- Create the iterator and set the filter mask.
- setFilter() : mixed
- Set the iterator filter and reset the internal pointer.
Constants
ALL
public
mixed
ALL
= 8
DISABLED
public
mixed
DISABLED
= 16
FILTER
public
mixed
FILTER
= 1
QUERY
public
mixed
QUERY
= 2
VFOLDER
public
mixed
VFOLDER
= 4
Properties
$_mask
Filtering mask.
protected
int
$_mask
= 0
Methods
accept()
public
accept() : bool
Return values
boolcreate()
Create the iterator and set the filter mask.
public
static create([int $mask = 0 ]) : IMP_Search_IteratorFilter
Parameters
- $mask : int = 0
-
See setFilter().
Return values
IMP_Search_IteratorFilter —Iterator.
setFilter()
Set the iterator filter and reset the internal pointer.
public
setFilter([int $mask = 0 ]) : mixed
Parameters
- $mask : int = 0
-
A mask with the following possible elements:
- self::DISABLED: List even if disabled.
- self::FILTER: List filters.
- self::QUERY: List search queries.
- self::VFOLDER: List virtual folders.
- self::ALL: List filter, search queries, and virtual folders.