API Documentation

Zend/Queue/Stomp/Frame.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Queue  
Subpackage
Stomp  
Version
$Id: Frame.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Stomp_Frame

Package: Zend\Queue\Stomp

This class represents a Stomp Frame

Implements
\Zend_Queue_Stomp_FrameInterface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  END_OF_FRAME = "\x00\n"
Constant  CONTENT_LENGTH = 'content-length'
Constant  EOL = "\n"

Properties

Propertyprotected  $_autoContentLength= 'null'

Do the content-length automatically?

Default valuenullDetails
Type
Propertyprotectedstring  $_body= 'null'

The body of the frame

Default valuenullDetails
Type
string
Propertyprotectedstring  $_command= 'null'

The command for the frame

Default valuenullDetails
Type
string
Propertyprotectedarray  $_headers= 'array()'

Headers for the frame

Default valuearray()Details
Type
array

Methods

methodpublic__construct( ) : void

Constructor

methodpublic__toString( ) : string

Returns
Type Description
string
Details
See
\toFrame()  
methodpublicfromFrame( string $frame ) : \Zend_Queue_Stomp_Frame

Accepts a frame and deconstructs the frame into its component parts

Parameters
Name Type Description
$frame string
  • a stomp frame
Returns
Type Description
\Zend_Queue_Stomp_Frame
Details
Fluent
This method is part of a fluent interface and will return the same instance  
methodpublicgetAutoContentLength( ) : boolean

get the status of the auto content length

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
Type Description
boolean
methodpublicgetBody( ) : false|string

Return the body for this frame

Returns false if the body does not exist

Returns
Type Description
false|string
methodpublicgetCommand( ) : string|false

Return the command for this frame

Return false if the command does not exist

Returns
Type Description
string|false
methodpublicgetHeader( string $header ) : string|false

Returns a value for a header

Returns false if the header does not exist.

Parameters
Name Type Description
$header string
Returns
Type Description
string|false
Throws
Exception Description
\Zend_Queue_Exception
methodpublicgetHeaders( ) : array

Get the headers

Returns
Type Description
array
methodpublicsetAutoContentLength( boolean $auto ) : \$this;

setAutoContentLength()

Set the value on or off.

Parameters
Name Type Description
$auto boolean
Returns
Type Description
\$this;
Throws
Exception Description
\Zend_Queue_Exception
methodpublicsetBody( string|null $body ) : \Zend_Queue_Stomp_Frame

Set the body for this frame

Set to null for no body.

Parameters
Name Type Description
$body string|null
Returns
Type Description
\Zend_Queue_Stomp_Frame
Throws
Exception Description
\Zend_Queue_Exception
methodpublicsetCommand(  $command ) : \Zend_Queue_Stomp_Frame

Set the body for this frame

Parameters
Name Type Description
$command

string|null

Returns
Type Description
\Zend_Queue_Stomp_Frame
Throws
Exception Description
\Zend_Queue_Exception
methodpublicsetHeader( string $header, string $value ) : \Zend_Queue_Stomp_Frame

Sets a value for a header

Parameters
Name Type Description
$header string
$value string
Returns
Type Description
\Zend_Queue_Stomp_Frame
Throws
Exception Description
\Zend_Queue_Exception
methodpublicsetHeaders( array $headers ) : \Zend_Queue_Stomp_Frame

Set the headers

Throws an exception if the array values are not strings.

Parameters
Name Type Description
$headers array
Returns
Type Description
\Zend_Queue_Stomp_Frame
Throws
Exception Description
\Zend_Queue_Exception
Details
Fluent
This method is part of a fluent interface and will return the same instance  
methodpublictoFrame( ) : string

Takes the current parameters and returns a Stomp Frame

Returns
Type Description
string
Throws
Exception Description
\Zend_Queue_Exception
Documentation was generated by DocBlox 0.15.1.