Class Swift_Events_CommandEvent

Description

Generated when Swift is sending a command

Located in /Swift/Events/CommandEvent.php (line 18)

Swift_Events
   |
   --Swift_Events_CommandEvent
Variable Summary
int $code
string $string
Method Summary
Swift_Events_CommandEvent __construct (string $string, [int $code = null])
int getCode ()
string getString ()
void setCode (int $code)
void setString (string $string)
Variables
int $code = null (line 29)

Contains the expected response code (or null)

  • access: protected
string $string = null (line 24)

Contains the command being sent

  • access: protected

Inherited Variables

Inherited from Swift_Events

Swift_Events::$swift
Methods
Constructor __construct (line 36)

Constructor

  • access: public
Swift_Events_CommandEvent __construct (string $string, [int $code = null])
  • string $string: The command being sent
  • int $code: The expected code
getCode (line 70)

Get the expected response code

  • access: public
int getCode ()
getString (line 53)

Get the command being sent

  • access: public
string getString ()
setCode (line 61)

Set response code which is expected

  • access: public
void setCode (int $code)
  • int $code: The response code
setString (line 45)

Set the command being sent (without CRLF)

  • access: public
void setString (string $string)
  • string $string: The command being sent

Inherited Methods

Inherited From Swift_Events

Swift_Events::getSwift()
Swift_Events::setSwift()

Documentation generated on Wed, 26 Mar 2008 20:33:04 +1100 by phpDocumentor 1.3.1