Amf/Request.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_Amf
version: $Id: Request.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Amf_Request

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

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_Amf
todo: Currently not checking if the object needs to be Type Mapped to a server object.
Properties: $_clientType; $_bodies; $_headers; $_objectEncoding; $_inputStream; $_deserializer; $_time
Methods: initialize; readMessage; readHeader; readBody; getAmfBodies; addAmfBody; getAmfHeaders; getObjectEncoding; setObjectEncoding

Description

Handle the incoming AMF request by deserializing the data to php object types and storing the data for Zend_Amf_Server to handle for processing.

Properties

$_bodies
jump to class

array $_bodies = 'array'

Details

$_bodies: array
Message bodies
visibility: protected
default: array
final: false
static: false

$_clientType
jump to class

int $_clientType = '0'

Details

$_clientType: int
AMF client type (AMF0, AMF3)
visibility: protected
default: 0
final: false
static: false

$_deserializer
jump to class

Zend_Amf_Parse_AMF0_Deserializer $_deserializer = ''

Details

$_deserializer: Zend_Amf_Parse_AMF0_Deserializer
visibility: protected
default
final: false
static: false

$_headers
jump to class

array $_headers = 'array'

Details

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

$_inputStream
jump to class

Zend_Amf_Parse_InputStream $_inputStream = ''

Details

$_inputStream: Zend_Amf_Parse_InputStream
visibility: protected
default
final: false
static: false

$_objectEncoding
jump to class

int $_objectEncoding = '0'

Details

$_objectEncoding: int
Message encoding to use for objects in response
visibility: protected
default: 0
final: false
static: false

$_time
jump to class

mixed $_time = ''

Time of the request

Details

$_time: mixed
visibility: protected
default
final: false
static: false

Methods

addAmfBody
jump to class

addAmfBody(
          Zend_Amf_Value_MessageBody $message
          )
        
        :
        Zend_Amf_Request

Accessor to private array of message bodies.

Arguments

$message: Zend_Amf_Value_MessageBody

Output

Zend_Amf_Request

Details

visibility: public
final: false
static: false

getAmfBodies
jump to class

getAmfBodies(
          
          )
        
        :
        array

Return an array of the body objects that were found in the amf request.

Output

array: {target, response, length, content}

Details

visibility: public
final: false
static: false

getAmfHeaders
jump to class

getAmfHeaders(
          
          )
        
        :
        array

Return an array of headers that were found in the amf request.

Output

array: {operation, mustUnderstand, length, param}

Details

visibility: public
final: false
static: false

getObjectEncoding
jump to class

getObjectEncoding(
          
          )
        
        :
        int

Return the either 0 or 3 for respect AMF version

Output

int

Details

visibility: public
final: false
static: false

initialize
jump to class

initialize(
          string $request
          )
        
        :
        Zend_Amf_Request

Prepare the AMF InputStream for parsing.

Arguments

$request: string

Output

Zend_Amf_Request

Details

visibility: public
final: false
static: false

readBody
jump to class

readBody(
          
          )
        
        :
        Zend_Amf_Value_MessageBody

Deserialize a message body from the input stream

Output

Zend_Amf_Value_MessageBody

Details

visibility: public
final: false
static: false

readHeader
jump to class

readHeader(
          
          )
        
        :
        Zend_Amf_Value_MessageHeader

Deserialize a message header from the input stream.

A message header is structured as: - NAME String - MUST UNDERSTAND Boolean - LENGTH Int - DATA Object

Output

Zend_Amf_Value_MessageHeader

Details

visibility: public
final: false
static: false

readMessage
jump to class

readMessage(
           $stream
          )
        
        :
        Zend_Amf_Request

Takes the raw AMF input stream and converts it into valid PHP objects

Arguments

$stream: Zend_Amf_Parse_InputStream

Output

Zend_Amf_Request

Details

visibility: public
final: false
static: false

setObjectEncoding
jump to class

setObjectEncoding(
          mixed $int
          )
        
        :
        Zend_Amf_Request

Set the object response encoding

Arguments

$int: mixed

Output

Zend_Amf_Request

Details

visibility: public
final: false
static: false

API Documentation

Amf/Request.php

Description

Zend_Amf_Requestjump to top

Description

Properties

$_bodiesjump to class

Details

$_clientTypejump to class

Details

$_deserializerjump to class

Details

$_headersjump to class

Details

$_inputStreamjump to class

Details

$_objectEncodingjump to class

Details

$_timejump to class

Details

Methods

addAmfBodyjump to class

Arguments

Output

Details

getAmfBodiesjump to class

Output

Details

getAmfHeadersjump to class

Output

Details

getObjectEncodingjump to class

Output

Details

initializejump to class

Arguments

Output

Details

readBodyjump to class

Output

Details

readHeaderjump to class

Output

Details

readMessagejump to class

Arguments

Output

Details

setObjectEncodingjump to class

Arguments

Output

Details

Zend_Amf_Request
jump to top

$_bodies
jump to class

$_clientType
jump to class

$_deserializer
jump to class

$_headers
jump to class

$_inputStream
jump to class

$_objectEncoding
jump to class

$_time
jump to class

addAmfBody
jump to class

getAmfBodies
jump to class

getAmfHeaders
jump to class

getObjectEncoding
jump to class

initialize
jump to class

readBody
jump to class

readHeader
jump to class

readMessage
jump to class

setObjectEncoding
jump to class