Zend Framework API Documentation » \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.

package	Zend_Amf
subpackage	Value
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License

Methods

Constructor

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

Parameters

$targetUri

string

$responseUri

string

$data

string

Retrieve response data

getData() : string

Returns

string

Get target Uri

getResponseUri() : string

Returns

string

Retrieve target Uri

getTargetUri() : string

Returns

string

Set response data

setData(mixed $data) : \Zend_Amf_Value_MessageBody

Parameters

$data

mixed

Returns

\Zend_Amf_Value_MessageBody

Set reply method

setReplyMethod(string $methodName) : \Zend_Amf_Value_MessageBody

Parameters

$methodName

string

Returns

\Zend_Amf_Value_MessageBody

Set response Uri

setResponseUri(string $responseUri) : \Zend_Amf_Value_MessageBody

Parameters

$responseUri

string

Returns

\Zend_Amf_Value_MessageBody

Set target Uri

setTargetUri(string $targetUri) : \Zend_Amf_Value_MessageBody

Parameters

$targetUri

string

Returns

\Zend_Amf_Value_MessageBody

Properties

Contains the actual data associated with the operation. It contains the client's parameter data that is passed to the server's operation/method.

$_data : string

Default

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.

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.

$_responseUri : string

Default

""

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.

A string describing which operation, function, or method is to be remotley invoked.

$_targetUri : string

Default

""