PHP Класс Horde_Imap_Client_Interaction_Command, horde

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

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

Свойство Тип Описание
$debug array Multiple entries refer to the various steps in a continuation command.
$literal8 boolean Are literal8's available?
$literalplus boolean Use LITERAL+ if available
$on_error callback If callback returns true, the command will be treated as successful.
$on_success callback A callback to run on success.
$pipeline Horde_Imap_Client_Interaction_Pipeline Pipeline object associated with this command.
$response Horde_Imap_Client_Interaction_Server Server response.
$tag string The command tag.

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

Свойство Тип Описание
$_timer Horde_Support_Timer Command timer.

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

Метод Описание
__construct ( string $cmd, string $tag = null ) Constructor.
__get ( $name )
getCommand ( ) : string Get the command.
getTimer ( ) : mixed Return the timer data.
startTimer ( ) Start the command timer.

Защищенные методы

Метод Описание
_continuationCheck ( $list ) Recursive check for continuation functions.

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

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

Constructor.
public __construct ( string $cmd, string $tag = null )
$cmd string The IMAP command.
$tag string The tag to use. If not set, will be automatically generated.

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

public __get ( $name )

_continuationCheck() защищенный Метод

Recursive check for continuation functions.
protected _continuationCheck ( $list )

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

Get the command.
public getCommand ( ) : string
Результат string The command.

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

Return the timer data.
public getTimer ( ) : mixed
Результат mixed Null if timer wasn't started, or a float containing elapsed command time.

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

Start the command timer.
public startTimer ( )

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

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

Command timer.
protected Horde_Support_Timer $_timer
Результат Horde_Support_Timer

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

Multiple entries refer to the various steps in a continuation command.
public array $debug
Результат array

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

Are literal8's available?
public bool $literal8
Результат boolean

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

Use LITERAL+ if available
public bool $literalplus
Результат boolean

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

If callback returns true, the command will be treated as successful.
С версии: 2.24.0
public callback $on_error
Результат callback

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

A callback to run on success.
С версии: 2.28.0
public callback $on_success
Результат callback

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

Pipeline object associated with this command.
С версии: 2.28.0
public Horde_Imap_Client_Interaction_Pipeline $pipeline
Результат Horde_Imap_Client_Interaction_Pipeline

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

Server response.
public Horde_Imap_Client_Interaction_Server $response
Результат Horde_Imap_Client_Interaction_Server

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

The command tag.
public string $tag
Результат string