• Home
  • Horde_Imap_Client_Interaction_Pipeline

PHP Class Horde_Imap_Client_Interaction_Pipeline, horde

Since: 2.10.0
Author: Michael Slusarz ([email protected])
Inheritance: implements Countable, implements IteratorAggregate
Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$data array Data storage from server responses.
$fetch Horde_Imap_Client_Fetch_Results Fetch results.

Protected Properties

Property Type Description
$_commands array The list of commands.
$_todo array The list of commands to complete.

Public Methods

Method Description
__construct ( Horde_Imap_Client_Fetch_Results $fetch ) Constructor.
__get ( $name )
add ( Horde_Imap_Client_Interaction_Command $cmd, boolean $top = false ) Add a command to the pipeline.
complete ( Horde_Imap_Client_Interaction_Server_Tagged $resp ) : Horde_Imap_Client_Interaction_Command Mark a command as completed.
count ( )
getCmd ( string $tag ) : Horde_Imap_Client_Interaction_Command Return the command for a given tag.
getIterator ( )

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Imap_Client_Fetch_Results $fetch )
$fetch Horde_Imap_Client_Fetch_Results Fetch results object.

__get() public method

public __get ( $name )

add() public method

Add a command to the pipeline.
public add ( Horde_Imap_Client_Interaction_Command $cmd, boolean $top = false )
$cmd Horde_Imap_Client_Interaction_Command Command object.
$top boolean Add command to top of queue?

complete() public method

Mark a command as completed.
public complete ( Horde_Imap_Client_Interaction_Server_Tagged $resp ) : Horde_Imap_Client_Interaction_Command
$resp Horde_Imap_Client_Interaction_Server_Tagged Tagged server response.
return Horde_Imap_Client_Interaction_Command Command that was completed. Returns null if tagged response is not contained in this pipeline object.

count() public method

public count ( )

getCmd() public method

Return the command for a given tag.
public getCmd ( string $tag ) : Horde_Imap_Client_Interaction_Command
$tag string The command tag.
return Horde_Imap_Client_Interaction_Command A command object (or null if the tag does not exist).

getIterator() public method

public getIterator ( )

Property Details

$_commands protected_oe property

The list of commands.
protected array $_commands
return array

$_todo protected_oe property

The list of commands to complete.
protected array $_todo
return array

$data public_oe property

Data storage from server responses.
public array $data
return array

$fetch public_oe property

Fetch results.
public Horde_Imap_Client_Fetch_Results $fetch
return Horde_Imap_Client_Fetch_Results