IMP_Ftree_Prefs_Poll
extends IMP_Ftree_Prefs
in package
Manage the mailbox poll list.
Tags
Table of Contents
Properties
- $locked : bool
- $_data : array<string|int, mixed>
- Preference data.
- $_locked : bool
- Is the preference locked?
- $_ftree : IMP_Ftree
- Tree object.
Methods
- __construct() : mixed
- Constructor.
- __get() : mixed
- addPollList() : mixed
- Add elements to the poll list.
- getPollList() : array<string|int, mixed>
- Returns the list of mailboxes to poll.
- offsetExists() : bool
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : void
- prunePollList() : mixed
- Prune non-existent mailboxes from poll list.
- removePollList() : mixed
- Remove elements from the poll list.
- shutdown() : mixed
Properties
$locked read-only
public
bool
$locked
True if pref is locked.
$_data
Preference data.
protected
array<string|int, mixed>
$_data
= array()
$_locked
Is the preference locked?
protected
bool
$_locked
$_ftree
Tree object.
private
IMP_Ftree
$_ftree
Methods
__construct()
Constructor.
public
__construct(IMP_Ftree $ftree) : mixed
Parameters
- $ftree : IMP_Ftree
-
Tree object.
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
addPollList()
Add elements to the poll list.
public
addPollList(mixed $id) : mixed
Parameters
- $id : mixed
-
The element name or a list of element names to add.
getPollList()
Returns the list of mailboxes to poll.
public
getPollList([bool $sort = false ]) : array<string|int, mixed>
Parameters
- $sort : bool = false
-
Sort the directory list?
Return values
array<string|int, mixed> —The list of mailboxes to poll (IMP_Mailbox objects).
offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
prunePollList()
Prune non-existent mailboxes from poll list.
public
prunePollList() : mixed
removePollList()
Remove elements from the poll list.
public
removePollList(mixed $id) : mixed
Parameters
- $id : mixed
-
The element name or a list of element names to remove.
shutdown()
public
shutdown() : mixed