Queue/Stomp/FrameInterface.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: FrameInterface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Queue_Stomp_FrameInterface

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_FrameInterface
jump to top

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
Methods: getAutoContentLength; setAutoContentLength; getHeaders; setHeaders; getHeader; setHeader; getBody; setBody; getCommand; setCommand; toFrame; __toString; fromFrame

Description

This class represents a Stomp Frame Interface

Methods

__toString
jump to class

__toString(
          
          )
        
        :

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(
          
          )
        
        :
        $this

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

Output

$this

Details

visibility: public
final: false
static: false

getCommand
jump to class

getCommand(
          
          )
        
        :
        $this

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

Output

$this

Details

visibility: public
final: false
static: false

getHeader
jump to class

getHeader(
          string $header
          )
        
        :
        $string

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

Arguments

$header: string

Output

$string

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
          )
        
        :
        $this

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

Set to null for no body.

Arguments

$body: stringnull

Output

$this

Details

visibility: public
final: false
static: false
throws

setCommand
jump to class

setCommand(
           $command
          )
        
        :
        $this

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

Arguments

$command

Output

$this

Details

visibility: public
final: false
static: false
throws

setHeader
jump to class

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

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

Arguments

$header: string
$value: string

Output

$this

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/FrameInterface.php

Description

Zend_Queue_Stomp_FrameInterfacejump to top

Description

Methods

__toStringjump to class

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_FrameInterface
jump to top

__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