Amf/Value/MessageBody.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Amf  
Subpackage
Value  
Version
$Id$  

\Zend_Amf_Value_MessageBody

Package: Zend_Amf\Value
An AMF Message contains information about the actual individual transaction that is to be performed. It specifies the remote operation that is to be performed; a local (client) operation to be invoked upon success; and, the data to be used in the operation.

This Message structure defines how a local client would invoke a method/operation on a remote server. Additionally, the response from the Server is structured identically.

Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_data
Contains the actual data associated with the operation. It contains the client's parameter data that is passed to the server's operation/method.
When serializing a root level data type or a parameter list array, no name field is included. That is, the data is anonomously represented as "Type Marker"/"Value" pairs. When serializing member data, the data is represented as a series of "Name"/"Type"/"Value" combinations. For server generated responses, it may contain any ActionScript data/objects that the server was expected to provide.
Details
Type
string
>VPropertyprotectedstring $_responseUri = ""
Universal Resource Identifier that uniquely targets the originator's Object that should receive the server's response. The server will use this path specification to target the "OnResult()" or "onStatus()" handlers within the client. For Flash, it specifies an ActionScript Object path only. The NetResponse object pointed to by the Response Uri contains the connection state information. Passing/specifying this provides a convenient mechanism for the client/server to share access to an object that is managing the state of the shared connection.
Since the server will use this field in the event of an error, this field is required even if a successful server request would not be expected to return a value to the client.
Default value""Details
Type
string
>VPropertyprotectedstring $_targetUri = ""
A string describing which operation, function, or method is to be remotley invoked.
Default value""Details
Type
string

Methods

methodpublic__construct(string $targetUri, string $responseUri, string $data) : void

Constructor

Parameters
NameTypeDescription
$targetUristring
$responseUristring
$datastring
methodpublicgetData() : string

Retrieve response data

Returns
TypeDescription
string
methodpublicgetResponseUri() : string

Get target Uri

Returns
TypeDescription
string
methodpublicgetTargetUri() : string

Retrieve target Uri

Returns
TypeDescription
string
methodpublicsetData(mixed $data) : \Zend_Amf_Value_MessageBody

Set response data

Parameters
NameTypeDescription
$datamixed
Returns
TypeDescription
\Zend_Amf_Value_MessageBody
methodpublicsetReplyMethod(string $methodName) : \Zend_Amf_Value_MessageBody

Set reply method

Parameters
NameTypeDescription
$methodNamestring
Returns
TypeDescription
\Zend_Amf_Value_MessageBody
methodpublicsetResponseUri(string $responseUri) : \Zend_Amf_Value_MessageBody

Set response Uri

Parameters
NameTypeDescription
$responseUristring
Returns
TypeDescription
\Zend_Amf_Value_MessageBody
methodpublicsetTargetUri(string $targetUri) : \Zend_Amf_Value_MessageBody

Set target Uri

Parameters
NameTypeDescription
$targetUristring
Returns
TypeDescription
\Zend_Amf_Value_MessageBody
Documentation was generated by phpDocumentor 2.2.0 .