This class represents a Stomp Frame Interface

category Zend
package Zend_Queue
subpackage Stomp
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

__toString()

__toString() 
see

Accepts a frame and deconstructs the frame into its' component parts

fromFrame(string $frame) : \Zend_Queue_Stomp_FrameInterface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$frame

string
  • a stomp frame

Returns

\Zend_Queue_Stomp_FrameInterface

Get the status of the auto content length

getAutoContentLength() : boolean

If AutoContentLength is true this code will automatically put the content-length header in, even if it is already set by the user.

This is done to make the message sending more reliable.

Returns

boolean

Return the body for this frame returns false if the body does not exist

getBody() : \Zend_Queue_Stomp_FrameInterface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Zend_Queue_Stomp_FrameInterface

Return the command for this frame return false if the command does not exist

getCommand() : \Zend_Queue_Stomp_FrameInterface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Zend_Queue_Stomp_FrameInterface

Returns a value for a header returns false if the header does not exist

getHeader(string $header) : \$string

Parameters

$header

string

Exceptions

\Zend_Queue_Exception

Returns

\$string

Get the headers

getHeaders() : array

Returns

array

setAutoContentLength()

setAutoContentLength(boolean $auto) : \$this;

Set the value on or off.

Parameters

$auto

boolean

Exceptions

\Zend_Queue_Exception

Returns

\$this;

Set the body for this frame returns false if the body does not exist

setBody(string|null $body) : \Zend_Queue_Stomp_FrameInterface

Set to null for no body.

fluent This method is part of a fluent interface and will return the same instance

Parameters

$body

stringnull

Exceptions

\Zend_Queue_Exception

Returns

\Zend_Queue_Stomp_FrameInterface

Set the body for this frame returns false if the body does not exist

setCommand($command) : \Zend_Queue_Stomp_FrameInterface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$command

Exceptions

\Zend_Queue_Exception

Returns

\Zend_Queue_Stomp_FrameInterface

Returns a value for a header returns false if the header does not exist

setHeader(string $header, string $value) : \Zend_Queue_Stomp_FrameInterface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$header

string

$value

string

Exceptions

\Zend_Queue_Exception

Returns

\Zend_Queue_Stomp_FrameInterface

Set the headers

setHeaders(array $headers) : \Zend_Queue_Stomp_FrameInterface

Throws an exception if the array values are not strings.

fluent This method is part of a fluent interface and will return the same instance

Parameters

$headers

array

Exceptions

\Zend_Queue_Exception

Returns

\Zend_Queue_Stomp_FrameInterface

Takes the current parameters and returns a Stomp Frame

toFrame() : string

Exceptions

\Zend_Queue_Exception

Returns

string