Horde_Imap_Client_Interaction_Pipeline
in package
implements
Countable, IteratorAggregate
An object representing a series of IMAP client commands (RFC 3501 [2.2.1]) to be processed at the same time.
Tags
Interfaces, Classes, Traits and Enums
- Countable
- IteratorAggregate
Table of Contents
- $data : array<string|int, mixed>
- Data storage from server responses.
- $fetch : Horde_Imap_Client_Fetch_Results
- Fetch results.
- $finished : bool
- $_commands : array<string|int, mixed>
- The list of commands.
- $_todo : array<string|int, mixed>
- The list of commands to complete.
- __construct() : mixed
- Constructor.
- __get() : mixed
- add() : mixed
- Add a command to the pipeline.
- complete() : Horde_Imap_Client_Interaction_Command
- Mark a command as completed.
- count() : mixed
- getCmd() : Horde_Imap_Client_Interaction_Command
- Return the command for a given tag.
- getIterator() : mixed
Properties
$data
Data storage from server responses.
public
array<string|int, mixed>
$data
= array('modseqs' => array(), 'modseqs_nouid' => array())
$fetch
Fetch results.
public
Horde_Imap_Client_Fetch_Results
$fetch
$finished read-only
public
bool
$finished
True if all commands have finished.
$_commands
The list of commands.
protected
array<string|int, mixed>
$_commands
= array()
$_todo
The list of commands to complete.
protected
array<string|int, mixed>
$_todo
= array()
Methods
__construct()
Constructor.
public
__construct(Horde_Imap_Client_Fetch_Results $fetch) : mixed
Parameters
- $fetch : Horde_Imap_Client_Fetch_Results
-
Fetch results object.
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —add()
Add a command to the pipeline.
public
add(Horde_Imap_Client_Interaction_Command $cmd[, bool $top = false ]) : mixed
Parameters
- $cmd : Horde_Imap_Client_Interaction_Command
-
Command object.
- $top : bool = false
-
Add command to top of queue?
Return values
mixed —complete()
Mark a command as completed.
public
complete(Horde_Imap_Client_Interaction_Server_Tagged $resp) : Horde_Imap_Client_Interaction_Command
Parameters
- $resp : Horde_Imap_Client_Interaction_Server_Tagged
-
Tagged server response.
Return values
Horde_Imap_Client_Interaction_Command —Command that was completed. Returns null if tagged response is not contained in this pipeline object.
count()
public
count() : mixed
Return values
mixed —getCmd()
Return the command for a given tag.
public
getCmd(string $tag) : Horde_Imap_Client_Interaction_Command
Parameters
- $tag : string
-
The command tag.
Return values
Horde_Imap_Client_Interaction_Command —A command object (or null if the tag does not exist).
getIterator()
public
getIterator() : mixed