Queue/Stomp/Frame.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Queue
subpackage: Stomp
version: $Id: Frame.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Queue_Stomp_Frame

Description

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.

Zend_Queue_Stomp_Frame
jump to top

Implements: Zend_Queue_Stomp_FrameInterface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Queue
subpackage: Stomp
Constants: END_OF_FRAME; CONTENT_LENGTH; EOL
Properties: $_headers; $_command; $_body; $_autoContentLength
Methods: __construct; getAutoContentLength; setAutoContentLength; getHeaders; setHeaders; setHeader; getHeader; getBody; setBody; getCommand; setCommand; toFrame; __toString; fromFrame

Description

This class represents a Stomp Frame

Constants

END_OF_FRAME
jump to class

 END_OF_FRAME = '\x00\n'

Details

value: \x00\n

CONTENT_LENGTH
jump to class

 CONTENT_LENGTH = 'content-length'

Details

value: content-length

EOL
jump to class

 EOL = '\n'

Details

value: \n

Properties

$_autoContentLength
jump to class

$_autoContentLength = 'null'

Do the content-length automatically?

Details

visibility: protected
default: null
final: false
static: false

$_body
jump to class

string $_body = 'null'

The body of the frame

Details

$_body: string
visibility: protected
default: null
final: false
static: false

$_command
jump to class

string $_command = 'null'

The command for the frame

Details

$_command: string
visibility: protected
default: null
final: false
static: false

$_headers
jump to class

array $_headers = 'array'

Headers for the frame

Details

$_headers: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

Constructor

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Output

string

Details

visibility: public
final: false
static: false
see: toFrame()

fromFrame
jump to class

fromFrame(
          string $frame
          )
        
        :
        $this

Accepts a frame and deconstructs the frame into its component parts

Arguments

$frame: string
- a stomp frame

Output

$this

Details

visibility: public
final: false
static: false

getAutoContentLength
jump to class

getAutoContentLength(
          
          )
        
        :
        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.

Output

boolean

Details

visibility: public
final: false
static: false

getBody
jump to class

getBody(
          
          )
        
        :
        false|string

Return the body for this frame

Returns false if the body does not exist

Output

false|string

Details

visibility: public
final: false
static: false

getCommand
jump to class

getCommand(
          
          )
        
        :
        string|false

Return the command for this frame

Return false if the command does not exist

Output

string|false

Details

visibility: public
final: false
static: false

getHeader
jump to class

getHeader(
          string $header
          )
        
        :
        string|false

Returns a value for a header

Returns false if the header does not exist.

Arguments

$header: string

Output

string|false

Details

visibility: public
final: false
static: false
throws

getHeaders
jump to class

getHeaders(
          
          )
        
        :
        array

Get the headers

Output

array

Details

visibility: public
final: false
static: false

setAutoContentLength
jump to class

setAutoContentLength(
          boolean $auto
          )
        
        :
        $this;

setAutoContentLength()

Set the value on or off.

Arguments

$auto: boolean

Output

$this;

Details

visibility: public
final: false
static: false
throws

setBody
jump to class

setBody(
          string|null $body
          )
        
        :
        Zend_Queue_Stomp_Frame

Set the body for this frame

Set to null for no body.

Arguments

$body: stringnull

Output

Zend_Queue_Stomp_Frame

Details

visibility: public
final: false
static: false
throws

setCommand
jump to class

setCommand(
           $command
          )
        
        :
        Zend_Queue_Stomp_Frame

Set the body for this frame

Arguments

$command: string|null

Output

Zend_Queue_Stomp_Frame

Details

visibility: public
final: false
static: false
throws

setHeader
jump to class

setHeader(
          string $header, string $value
          )
        
        :
        Zend_Queue_Stomp_Frame

Sets a value for a header

Arguments

$header: string
$value: string

Output

Zend_Queue_Stomp_Frame

Details

visibility: public
final: false
static: false
throws

setHeaders
jump to class

setHeaders(
          array $headers
          )
        
        :
        $this

Set the headers

Throws an exception if the array values are not strings.

Arguments

$headers: array

Output

$this

Details

visibility: public
final: false
static: false
throws

toFrame
jump to class

toFrame(
          
          )
        
        :
        string

Takes the current parameters and returns a Stomp Frame

Output

string

Details

visibility: public
final: false
static: false
throws

API Documentation

Queue/Stomp/Frame.php

Description

Zend_Queue_Stomp_Framejump to top

Description

Constants

END_OF_FRAMEjump to class

Details

CONTENT_LENGTHjump to class

Details

EOLjump to class

Details

Properties

$_autoContentLengthjump to class

Details

$_bodyjump to class

Details

$_commandjump to class

Details

$_headersjump to class

Details

Methods

__constructjump to class

Details

__toStringjump to class

Output

Details

fromFramejump to class

Arguments

Output

Details

getAutoContentLengthjump to class

Output

Details

getBodyjump to class

Output

Details

getCommandjump to class

Output

Details

getHeaderjump to class

Arguments

Output

Details

getHeadersjump to class

Output

Details

setAutoContentLengthjump to class

Arguments

Output

Details

setBodyjump to class

Arguments

Output

Details

setCommandjump to class

Arguments

Output

Details

setHeaderjump to class

Arguments

Output

Details

setHeadersjump to class

Arguments

Output

Details

toFramejump to class

Output

Details

Zend_Queue_Stomp_Frame
jump to top

END_OF_FRAME
jump to class

CONTENT_LENGTH
jump to class

EOL
jump to class

$_autoContentLength
jump to class

$_body
jump to class

$_command
jump to class

$_headers
jump to class

__construct
jump to class

__toString
jump to class

fromFrame
jump to class

getAutoContentLength
jump to class

getBody
jump to class

getCommand
jump to class

getHeader
jump to class

getHeaders
jump to class

setAutoContentLength
jump to class

setBody
jump to class

setCommand
jump to class

setHeader
jump to class

setHeaders
jump to class

toFrame
jump to class