IMP_Ftree_IteratorFilter
in package
implements
Iterator
Iterator filter for IMP_Ftree.
Tags
Table of Contents
Interfaces
- Iterator
Constants
- CHILDREN = 1
- Filter mask constants.
- CONTAINERS = 2
- EXPANDED = 4
- NONIMAP = 8
- POLLED = 16
- REMOTE = 32
- SPECIALMBOXES = 64
- UNSUB = 128
- VFOLDER = 256
Properties
- $iterator : Iterator
- Master iterator object.
- $mboxes : array<string|int, mixed>
- A list of mailboxes to filter out.
- $_mask : int
- Filter mask.
- $_filter : Iterator
- Filtered iterator used for actual iteration.
Methods
- __construct() : mixed
- Constructor.
- add() : mixed
- Add filter masks.
- current() : mixed
- key() : mixed
- next() : void
- remove() : mixed
- Remove filter masks.
- rewind() : void
- valid() : bool
Constants
CHILDREN
Filter mask constants.
public
mixed
CHILDREN
= 1
- CHILDREN: Don't include child elements.
- CONTAINERS: Don't include container elements.
- EXPANDED: Don't include unexpanded mailboxes.
- NONIMAP: Don't include non-IMAP elements.
- POLLED: Don't include non-polled elements.
- REMOTE: Don't include remote accounts.
- SPECIALMBOXES: Don't include special mailboxes.
- UNSUB: Don't include unsubscribed elements.
- VFOLDER: Don't include Virtual Folders.
CONTAINERS
public
mixed
CONTAINERS
= 2
EXPANDED
public
mixed
EXPANDED
= 4
NONIMAP
public
mixed
NONIMAP
= 8
POLLED
public
mixed
POLLED
= 16
REMOTE
public
mixed
REMOTE
= 32
SPECIALMBOXES
public
mixed
SPECIALMBOXES
= 64
UNSUB
public
mixed
UNSUB
= 128
VFOLDER
public
mixed
VFOLDER
= 256
Properties
$iterator
Master iterator object.
public
Iterator
$iterator
$mboxes
A list of mailboxes to filter out.
public
array<string|int, mixed>
$mboxes
= array()
$_mask
Filter mask.
protected
int
$_mask
$_filter
Filtered iterator used for actual iteration.
private
Iterator
$_filter
Methods
__construct()
Constructor.
public
__construct([Iterator $i = null ]) : mixed
Parameters
- $i : Iterator = null
-
Master iterator object.
add()
Add filter masks.
public
add(mixed $mask) : mixed
Parameters
- $mask : mixed
-
Filter masks to add.
current()
public
current() : mixed
key()
public
key() : mixed
next()
public
next() : void
remove()
Remove filter masks.
public
remove(mixed $mask) : mixed
Parameters
- $mask : mixed
-
Filter masks to remove.
rewind()
public
rewind() : void
valid()
public
valid() : bool