PHP Класс Horde_Imap_Client_Interaction_Pipeline, horde

С версии: 2.10.0
Автор: Michael Slusarz ([email protected])
Наследование: implements Countable, implements IteratorAggregate
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$data array Data storage from server responses.
$fetch Horde_Imap_Client_Fetch_Results Fetch results.

Защищенные свойства (Protected)

Свойство Тип Описание
$_commands array The list of commands.
$_todo array The list of commands to complete.

Открытые методы

Метод Описание
__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 ( )

Описание методов

__construct() публичный Метод

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

__get() публичный Метод

public __get ( $name )

add() публичный Метод

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() публичный Метод

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.
Результат Horde_Imap_Client_Interaction_Command Command that was completed. Returns null if tagged response is not contained in this pipeline object.

count() публичный Метод

public count ( )

getCmd() публичный Метод

Return the command for a given tag.
public getCmd ( string $tag ) : Horde_Imap_Client_Interaction_Command
$tag string The command tag.
Результат Horde_Imap_Client_Interaction_Command A command object (or null if the tag does not exist).

getIterator() публичный Метод

public getIterator ( )

Описание свойств

$_commands защищенное свойство

The list of commands.
protected array $_commands
Результат array

$_todo защищенное свойство

The list of commands to complete.
protected array $_todo
Результат array

$data публичное свойство

Data storage from server responses.
public array $data
Результат array

$fetch публичное свойство

Fetch results.
public Horde_Imap_Client_Fetch_Results $fetch
Результат Horde_Imap_Client_Fetch_Results