API Documentation

Amf/Value/MessageBody.php

Classes 
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
subpackage
Value
version
$Id: MessageBody.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Amf_Value_MessageBody

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_Value_MessageBody
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
subpackage
Value
Properties
$_targetUri
$_responseUri
$_data
Methods
__construct
getTargetUri
setTargetUri
getResponseUri
setResponseUri
getData
setData
setReplyMethod

Description

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.

Properties

$_data
jump to class

string $_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

$_data
string
visibility
protected
default
final
false
static
false

$_responseUri
jump to class

string $_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.

Details

$_responseUri
string
visibility
protected
default
final
false
static
false

$_targetUri
jump to class

string $_targetUri = ''

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

Details

$_targetUri
string
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

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

Constructor

Arguments
$targetUri
string
$responseUri
string
$data
string
Details
visibility
public
final
false
static
false

getData
jump to class

getData( ) : string

Retrieve response data

Output
string
Details
visibility
public
final
false
static
false

getResponseUri
jump to class

getResponseUri( ) : string

Get target Uri

Output
string
Details
visibility
public
final
false
static
false

getTargetUri
jump to class

getTargetUri( ) : string

Retrieve target Uri

Output
string
Details
visibility
public
final
false
static
false

setData
jump to class

setData( mixed $data ) : Zend_Amf_Value_MessageBody

Set response data

Arguments
$data
mixed
Output
Zend_Amf_Value_MessageBody
Details
visibility
public
final
false
static
false

setReplyMethod
jump to class

setReplyMethod( string $methodName ) : Zend_Amf_Value_MessageBody

Set reply method

Arguments
$methodName
string
Output
Zend_Amf_Value_MessageBody
Details
visibility
public
final
false
static
false

setResponseUri
jump to class

setResponseUri( string $responseUri ) : Zend_Amf_Value_MessageBody

Set response Uri

Arguments
$responseUri
string
Output
Zend_Amf_Value_MessageBody
Details
visibility
public
final
false
static
false

setTargetUri
jump to class

setTargetUri( string $targetUri ) : Zend_Amf_Value_MessageBody

Set target Uri

Arguments
$targetUri
string
Output
Zend_Amf_Value_MessageBody
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.