pssht  latest
SSH server library written in PHP
fpoirotte\Pssht\Messages\DEBUG Class Reference
+ Inheritance diagram for fpoirotte\Pssht\Messages\DEBUG:

Public Member Functions

 __construct ($alwaysDisplay, $message, $language)
 
 getLanguage ()
 
 getMessage ()
 
 mustAlwaysDisplay ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 

Static Public Member Functions

static getMessageId ()
 
static unserialize (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Protected Attributes

 $alwaysDisplay
 Whether to always display the message or not.
 
 $language
 Language the debug message is written into (from RFC 3066).
 
 $message
 Actual debug message.
 

Detailed Description

SSH_MSG_DEBUG message (RFC 4253).

Definition at line 17 of file DEBUG.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\DEBUG::__construct (   $alwaysDisplay,
  $message,
  $language 
)

Construct a new debug message.

Parameters
bool$alwaysDisplayIndicates whether the debug message should always be shown to users (true) or if it may be hidden (false).
string$messageThe actual debug message, in ISO-10646 UTF-8 encoding.
string$languageLanguage tag the debug message is written into, in RFC 3066 format.

Definition at line 43 of file DEBUG.php.

References fpoirotte\Pssht\Messages\DEBUG\$alwaysDisplay, fpoirotte\Pssht\Messages\DEBUG\$language, and fpoirotte\Pssht\Messages\DEBUG\$message.

Member Function Documentation

fpoirotte\Pssht\Messages\DEBUG::getLanguage ( )

Get the language for the debug message.

Return values
stringLanguage tag the debug message is written into, in RFC 3066 format.

Definition at line 113 of file DEBUG.php.

References fpoirotte\Pssht\Messages\DEBUG\$language.

fpoirotte\Pssht\Messages\DEBUG::getMessage ( )

Get the actual debug message.

Return values
stringDebug message.

Definition at line 101 of file DEBUG.php.

References fpoirotte\Pssht\Messages\DEBUG\$message.

static fpoirotte\Pssht\Messages\DEBUG::getMessageId ( )
static

Retrieve the message's identifier.

Return values
intMessage identifier.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 60 of file DEBUG.php.

fpoirotte\Pssht\Messages\DEBUG::mustAlwaysDisplay ( )

Retrieve the flag indicating whether this debug message should always be displayed to users or not.

Return values
booltrue if the message should always be displayed, false otherwise.

Definition at line 90 of file DEBUG.php.

References fpoirotte\Pssht\Messages\DEBUG\$alwaysDisplay.

fpoirotte\Pssht\Messages\DEBUG::serialize ( \fpoirotte\Pssht\Wire\Encoder  $encoder)

Serialize the message.

Parameters
fpoirotte::Pssht::Wire::Encoder$encoderEncoder to use to perform serialization.
Return values
MessageInterfaceReturns this message.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 65 of file DEBUG.php.

static fpoirotte\Pssht\Messages\DEBUG::unserialize ( \fpoirotte\Pssht\Wire\Decoder  $decoder)
static

Unserialize some data into a message.

Parameters
fpoirotte::Pssht::Wire::Decoder$decoderDecoder to use to perform unserialization.
Return values
MessageInterfaceUnserialized message.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 73 of file DEBUG.php.

Referenced by fpoirotte\Pssht\Handlers\DEBUG\handle().


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