PHP Class Horde_Imap_Client_Interaction_Command, horde

Since: 2.10.0

Author: Michael Slusarz ([email protected])

Inheritance: extends Horde_Imap_Client_Data_Format_List

Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$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 Properties

Property	Type	Description
$_timer	Horde_Support_Timer	Command timer.

Public Methods

Method	Description
__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.

Protected Methods

Method	Description
_continuationCheck ( $list )	Recursive check for continuation functions.

Method Details

__construct() public method

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 method

public __get ( $name )

_continuationCheck() protected method

Recursive check for continuation functions.

protected _continuationCheck ( $list )

getCommand() public method

Get the command.

public getCommand ( ) : string
return	string	The command.

getTimer() public method

Return the timer data.

public getTimer ( ) : mixed
return	mixed	Null if timer wasn't started, or a float containing elapsed command time.

startTimer() public method

Start the command timer.

public startTimer ( )

Property Details

$_timer protected_oe property

Command timer.

protected Horde_Support_Timer $_timer
return	Horde_Support_Timer

$debug public_oe property

Multiple entries refer to the various steps in a continuation command.

public array $debug
return	array

$literal8 public_oe property

Are literal8's available?

public bool $literal8
return	boolean

$literalplus public_oe property

Use LITERAL+ if available

public bool $literalplus
return	boolean

$on_error public_oe property

If callback returns true, the command will be treated as successful.

Since: 2.24.0

public callback $on_error
return	callback

$on_success public_oe property

A callback to run on success.

Since: 2.28.0

public callback $on_success
return	callback

$pipeline public_oe property

Pipeline object associated with this command.

Since: 2.28.0

public Horde_Imap_Client_Interaction_Pipeline $pipeline
return	Horde_Imap_Client_Interaction_Pipeline

$response public_oe property

Server response.

public Horde_Imap_Client_Interaction_Server $response
return	Horde_Imap_Client_Interaction_Server

$tag public_oe property

The command tag.

public string $tag
return	string