API Documentation

Zend/Amf/Request.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_Amf  
Version
$Id: Request.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Amf_Request

Package: Zend\Amf

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.

Children
\Zend_Amf_Request_Http
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Todo
Currently not checking if the object needs to be Type Mapped to a server object.  

Properties

Propertyprotectedarray  $_bodies= 'array()'

Message bodies
Default valuearray()Details
Type
array
Propertyprotectedint  $_clientType= '0'

AMF client type (AMF0, AMF3)
Default value0Details
Type
int
Propertyprotected\Zend_Amf_Parse_AMF0_Deserializer  $_deserializer= ''

Details
Type
\Zend_Amf_Parse_AMF0_Deserializer
Propertyprotectedarray  $_headers= 'array()'

Message headers
Default valuearray()Details
Type
array
Propertyprotected\Zend_Amf_Parse_InputStream  $_inputStream= ''

Propertyprotectedint  $_objectEncoding= '0'

Message encoding to use for objects in response
Default value0Details
Type
int
Propertyprotectedmixed  $_time= ''

Time of the request

Details
Type
mixed

Methods

methodpublicaddAmfBody( \Zend_Amf_Value_MessageBody $message ) : \Zend_Amf_Request

Accessor to private array of message bodies.

Parameters
Name Type Description
$message \Zend_Amf_Value_MessageBody
Returns
Type Description
\Zend_Amf_Request
methodpublicgetAmfBodies( ) : array

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

Returns
Type Description
array {target, response, length, content}
methodpublicgetAmfHeaders( ) : array

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

Returns
Type Description
array {operation, mustUnderstand, length, param}
methodpublicgetObjectEncoding( ) : int

Return the either 0 or 3 for respect AMF version

Returns
Type Description
int
methodpublicinitialize( string $request ) : \Zend_Amf_Request

Prepare the AMF InputStream for parsing.

Parameters
Name Type Description
$request string
Returns
Type Description
\Zend_Amf_Request
methodpublicreadBody( ) : \Zend_Amf_Value_MessageBody

Deserialize a message body from the input stream

Returns
Type Description
\Zend_Amf_Value_MessageBody
methodpublicreadHeader( ) : \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

Returns
Type Description
\Zend_Amf_Value_MessageHeader
methodpublicreadMessage(  $stream ) : \Zend_Amf_Request

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

Parameters
Name Type Description
$stream

Zend_Amf_Parse_InputStream

Returns
Type Description
\Zend_Amf_Request
methodpublicsetObjectEncoding( mixed $int ) : \Zend_Amf_Request

Set the object response encoding

Parameters
Name Type Description
$int mixed
Returns
Type Description
\Zend_Amf_Request
Documentation was generated by DocBlox 0.15.1.