XOOPS RMCommon Utilities  2.1.8.91RC
 All Classes Namespaces Files Functions Variables
Swift_Events_CommandEvent Class Reference
Inheritance diagram for Swift_Events_CommandEvent:
Inheritance graph

Public Member Functions

 __construct (Swift_Transport $source, $command, $successCodes=array())
 
 getCommand ()
 
 getSuccessCodes ()
 
- Public Member Functions inherited from Swift_Events_EventObject
 __construct ($source)
 
 bubbleCancelled ()
 
 cancelBubble ($cancel=true)
 
 getSource ()
 

Private Attributes

 $_command
 
 $_successCodes = array()
 

Detailed Description

Definition at line 20 of file CommandEvent.php.

Constructor & Destructor Documentation

Swift_Events_CommandEvent::__construct ( Swift_Transport  $source,
  $command,
  $successCodes = array() 
)

Create a new CommandEvent for $source with $command.

Parameters
Swift_Transport$source
string$command
array$successCodes

Definition at line 41 of file CommandEvent.php.

References __construct().

Here is the call graph for this function:

Member Function Documentation

Swift_Events_CommandEvent::getCommand ( )

Get the command which was sent to the server.

Returns
string

Definition at line 53 of file CommandEvent.php.

References $_command.

Referenced by Swift_Plugins_BandwidthMonitorPlugin\commandSent(), and Swift_Plugins_LoggerPlugin\commandSent().

Here is the caller graph for this function:

Swift_Events_CommandEvent::getSuccessCodes ( )

Get the numeric response codes which indicate success for this command.

Returns
int[]

Definition at line 62 of file CommandEvent.php.

References $_successCodes.

Member Data Documentation

Swift_Events_CommandEvent::$_command
private

Definition at line 27 of file CommandEvent.php.

Referenced by getCommand().

Swift_Events_CommandEvent::$_successCodes = array()
private

Definition at line 33 of file CommandEvent.php.

Referenced by getSuccessCodes().


The documentation for this class was generated from the following file: