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

Public Member Functions

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

Static Public Member Functions

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

Protected Attributes

 $language
 Language the banner is written into, in RFC 3066 format.
 
 $message
 Banner to display.
 

Detailed Description

SSH_MSG_USERAUTH_BANNER message (RFC 4252).

Definition at line 17 of file BANNER.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\USERAUTH\BANNER::__construct (   $message,
  $language = '' 
)

Construct a new SSH_MSG_USERAUTH_BANNER message.

Parameters
string$messageBanner to display.
string$language(optional) Language for the banner, in RFC 3066 format. If omitted, the banner is assumed to be language-neutral.

Definition at line 36 of file BANNER.php.

References fpoirotte\Pssht\Messages\USERAUTH\BANNER\$language, and fpoirotte\Pssht\Messages\USERAUTH\BANNER\$message.

Member Function Documentation

fpoirotte\Pssht\Messages\USERAUTH\BANNER::getLanguage ( )

Get the language for the banner.

Return values
stringLanguage for the banner, in RFC 3066 format.
Note
An empty string is returned if the language is unknown or irrelevant (language-neutral banner).

Definition at line 91 of file BANNER.php.

References fpoirotte\Pssht\Messages\USERAUTH\BANNER\$language.

fpoirotte\Pssht\Messages\USERAUTH\BANNER::getMessage ( )

Get the banner.

Return values
stringBanner to dislay.

Definition at line 75 of file BANNER.php.

References fpoirotte\Pssht\Messages\USERAUTH\BANNER\$message.

static fpoirotte\Pssht\Messages\USERAUTH\BANNER::getMessageId ( )
static

Retrieve the message's identifier.

Return values
intMessage identifier.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 49 of file BANNER.php.

fpoirotte\Pssht\Messages\USERAUTH\BANNER::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 54 of file BANNER.php.

static fpoirotte\Pssht\Messages\USERAUTH\BANNER::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 61 of file BANNER.php.


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