Amf/Server.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: Server.php 21210 2010-02-27 10:37:39Z yoshida@zend.co.jp $
Classes: Zend_Amf_Server

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

Implements: Zend_Server_Interface
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: Server
todo: Make the reflection methods cache and autoload.
Properties: $_methods; $_classAllowed; $_loader; $_production; $_request; $_response; $_table; $_session; $_sesionNamespace; $_sessionName; $_auth; $_acl
Methods: __construct; setAuth; getAuth; setAcl; getAcl; setProduction; isProduction; setSession; isSession; _checkAcl; getLoader; _dispatch; _loadCommandMessage; _errorMessage; _handleAuth; _handle; handle; setRequest; getRequest; setResponse; getResponse; setClass; addFunction; addDirectory; getDirectory; _buildDispatchTable; fault; getFunctions; setPersistence; loadFunctions; setClassMap; listMethods

Description

An AMF gateway server implementation to allow the connection of the Adobe Flash Player to Zend Framework

Properties

$_acl
jump to class

Zend_Acl $_acl = ''

ACL handler object

Details

$_acl: Zend_Acl
visibility: protected
default
final: false
static: false

$_auth
jump to class

Zend_Amf_Auth_Abstract $_auth = ''

Authentication handler object

Details

$_auth: Zend_Amf_Auth_Abstract
visibility: protected
default
final: false
static: false

$_classAllowed
jump to class

array $_classAllowed = 'array'

Array of classes that can be called without being explicitly loaded

Keys are class names.

Details

$_classAllowed: array
visibility: protected
default: array
final: false
static: false

$_loader
jump to class

Zend_Loader_PluginLoader $_loader = ''

Loader for classes in added directories

Details

$_loader: Zend_Loader_PluginLoader
visibility: protected
default
final: false
static: false

$_methods
jump to class

array $_methods = 'array'

Array of dispatchables

Details

$_methods: array
visibility: protected
default: array
final: false
static: false

$_production
jump to class

bool $_production = 'true'

Details

$_production: bool
Production flag; whether or not to return exception messages
visibility: protected
default: true
final: false
static: false

$_request
jump to class

null|Zend_Amf_Request $_request = 'null'

Request processed

Details

$_request: null|Zend_Amf_Request
visibility: protected
default: null
final: false
static: false

$_response
jump to class

null|Zend_Amf_Response $_response = ''

Class to use for responses

Details

$_response: null|Zend_Amf_Response
visibility: protected
default
final: false
static: false

$_sesionNamespace
jump to class

Zend_Session_NameSpace $_sesionNamespace = 'zend_amf'

Namespace allows all AMF calls to not clobber other php session variables

Details

$_sesionNamespace: Zend_Session_NameSpace
default session namespace zend_amf
visibility: protected
default: zend_amf
final: false
static: false

$_session
jump to class

bool $_session = 'false'

Details

$_session: bool
session flag; whether or not to add a session to each response.
visibility: protected
default: false
final: false
static: false

$_sessionName
jump to class

string $_sessionName = 'PHPSESSID'

Set the default session.name if php_

Details

$_sessionName: string
visibility: protected
default: PHPSESSID
final: false
static: false

$_table
jump to class

array $_table = 'array'

Dispatch table of name => method pairs

Details

$_table: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

The server constructor

Details

visibility: public
final: false
static: false

_buildDispatchTable
jump to class

_buildDispatchTable(
          
          )
        
        :
        void

(Re)Build the dispatch table

The dispatch table consists of a an array of method name => Zend_Server_Reflection_Function_Abstract pairs

Details

visibility: protected
final: false
static: false

_checkAcl
jump to class

_checkAcl(
          string|object $object, string $function
          )
        
        :
        unknown_type

Check if the ACL allows accessing the function or method

Arguments

$object: stringobject
Object or class being accessed
$function: string
Function or method being accessed

Output

unknown_type

Details

visibility: protected
final: false
static: false

_dispatch
jump to class

_dispatch(
          string $method,  $params
              =
              null,  $source
              =
              null
          )
        
        :
        mixed

Loads a remote class or method and executes the function and returns the result

Arguments

$method: string
Is the method to execute
$params
$source

Output

mixed: $response the result of executing the method

Details

visibility: protected
final: false
static: false
throws

_errorMessage
jump to class

_errorMessage(
          int $objectEncoding, string $message, string $description, mixed $detail, int $code, int $line
          )
        
        :
        Zend_Amf_Value_Messaging_ErrorMessage|array

Create appropriate error message

Arguments

$objectEncoding: int
Current AMF encoding
$message: string
Message that was being processed when error happened
$description: string
Error description
$detail: mixed
Detailed data about the error
$code: int
Error code
$line: int
Error line

Output

Zend_Amf_Value_Messaging_ErrorMessage|array

Details

visibility: protected
final: false
static: false

_handle
jump to class

_handle(
          Zend_Amf_Request $request
          )
        
        :
        Zend_Amf_Response

Takes the deserialized AMF request and performs any operations.

Arguments

$request: Zend_Amf_Request

Output

Zend_Amf_Response

Details

visibility: protected
final: false
static: false
throws
todo: should implement and SPL observer pattern for custom AMF headers
todo: DescribeService support

_handleAuth
jump to class

_handleAuth(
          string $userid, string $password
          )
        
        :
        boolean

Handle AMF authentication

Arguments

$userid: string
$password: string

Output

boolean

Details

visibility: protected
final: false
static: false

_loadCommandMessage
jump to class

_loadCommandMessage(
          Zend_Amf_Value_Messaging_CommandMessage $message
          )
        
        :
        Zend_Amf_Value_Messaging_AcknowledgeMessage

Handles each of the 11 different command message types.

A command message is a flex.messaging.messages.CommandMessage

Arguments

$message: Zend_Amf_Value_Messaging_CommandMessage

Output

Zend_Amf_Value_Messaging_AcknowledgeMessage

Details

visibility: protected
final: false
static: false
see: Zend_Amf_Value_Messaging_CommandMessage

addDirectory
jump to class

addDirectory(
          string $dir
          )
        
        :

Creates an array of directories in which services can reside.

TODO: add support for prefixes?

Arguments

$dir: string

Details

visibility: public
final: false
static: false

addFunction
jump to class

addFunction(
          string|array $function, string $namespace
          )
        
        :
        Zend_Amf_Server

Attach a function to the server

Additional arguments to pass to the function at dispatch may be passed; any arguments following the namespace will be aggregated and passed at dispatch time.

Arguments

$function: stringarray
Valid callback
$namespace: string
Optional namespace prefix

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false
throws

fault
jump to class

fault(
          string|Exception $fault
              =
              null,  $code
              =
              404
          )
        
        :
        void

Raise a server fault

Unimplemented

Arguments

$fault: stringException
$code

Details

visibility: public
final: false
static: false

getAcl
jump to class

getAcl(
          
          )
        
        :
        Zend_Acl

Get ACL adapter

Output

Zend_Acl

Details

visibility: public
final: false
static: false

getAuth
jump to class

getAuth(
          
          )
        
        :
        Zend_Amf_Auth_Abstract

Get authentication adapter

Output

Zend_Amf_Auth_Abstract

Details

visibility: public
final: false
static: false

getDirectory
jump to class

getDirectory(
          
          )
        
        :
        array

Returns an array of directories that can hold services.

Output

array

Details

visibility: public
final: false
static: false

getFunctions
jump to class

getFunctions(
          
          )
        
        :
        array

Returns a list of registered methods

Returns an array of dispatchables (Zend_Server_Reflection_Function, _Method, and _Class items).

Output

array

Details

visibility: public
final: false
static: false

getLoader
jump to class

getLoader(
          
          )
        
        :
        Zend_Loader_PluginLoader

Get PluginLoader for the Server

Output

Zend_Loader_PluginLoader

Details

visibility: protected
final: false
static: false

getRequest
jump to class

getRequest(
          
          )
        
        :
        null|Zend_Amf_Request

Return currently registered request object

Output

null|Zend_Amf_Request

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Amf_Server_Response

get a reference to the Zend_Amf_response instance

Output

Zend_Amf_Server_Response

Details

visibility: public
final: false
static: false

handle
jump to class

handle(
          null|Zend_Amf_Request $request
              =
              null
          )
        
        :
        Zend_Amf_Response

Handle an AMF call from the gateway.

Arguments

$request: nullZend_Amf_Request
Optional

Output

Zend_Amf_Response

Details

visibility: public
final: false
static: false

isProduction
jump to class

isProduction(
          
          )
        
        :
        bool

Whether or not the server is in production

Output

bool

Details

visibility: public
final: false
static: false

isSession
jump to class

isSession(
          
          )
        
        :
        bool

Whether of not the server is using sessions

Output

bool

Details

visibility: public
final: false
static: false

listMethods
jump to class

listMethods(
          
          )
        
        :
        array

List all available methods

Returns an array of method names.

Output

array

Details

visibility: public
final: false
static: false

loadFunctions
jump to class

loadFunctions(
          array $definition
          )
        
        :
        void

Load server definition

Unimplemented

Arguments

$definition: array

Details

visibility: public
final: false
static: false

setAcl
jump to class

setAcl(
          Zend_Acl $acl
          )
        
        :
        Zend_Amf_Server

Set ACL adapter

Arguments

$acl: Zend_Acl

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

setAuth
jump to class

setAuth(
          Zend_Amf_Auth_Abstract $auth
          )
        
        :
        Zend_Amf_Server

Set authentication adapter

Arguments

$auth: Zend_Amf_Auth_Abstract

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

setClass
jump to class

setClass(
          string|object $class, string $namespace,  $argv
              =
              null
          )
        
        :
        Zend_Amf_Server

Attach a class or object to the server

Class may be either a class name or an instantiated object. Reflection is done on the class or object to determine the available public methods, and each is attached to the server as and available method. If a $namespace has been provided, that namespace is used to prefix AMF service call.

Arguments

$class: stringobject
$namespace: string
Optional
$argv

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false
throws: on invalid input

setClassMap
jump to class

setClassMap(
          string $asClass, string $phpClass
          )
        
        :
        Zend_Amf_Server

Map ActionScript classes to PHP classes

Arguments

$asClass: string
$phpClass: string

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

setPersistence
jump to class

setPersistence(
          mixed $mode
          )
        
        :
        void

Set server persistence

Unimplemented

Arguments

$mode: mixed

Details

visibility: public
final: false
static: false

setProduction
jump to class

setProduction(
          bool $flag
          )
        
        :
        Zend_Amf_Server

Set production flag

Arguments

$flag: bool

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

setRequest
jump to class

setRequest(
          string|Zend_Amf_Request $request
          )
        
        :
        Zend_Amf_Server

Set request object

Arguments

$request: stringZend_Amf_Request

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

setResponse
jump to class

setResponse(
          string|Zend_Amf_Server_Response $response
          )
        
        :
        Zend_Amf_Server

Public access method to private Zend_Amf_Server_Response reference

Arguments

$response: stringZend_Amf_Server_Response

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

setSession
jump to class

setSession(
          default $namespace
              =
              Zend_Amf
          )
        
        :
        Zend_Amf_Server

Arguments

$namespace: default
of all incoming sessions defaults to Zend_Amf

Output

Zend_Amf_Server

Details

visibility: public
final: false
static: false

API Documentation

Amf/Server.php

Description

Zend_Amf_Serverjump to top

Description

Properties

$_acljump to class

Details

$_authjump to class

Details

$_classAllowedjump to class

Details

$_loaderjump to class

Details

$_methodsjump to class

Details

$_productionjump to class

Details

$_requestjump to class

Details

$_responsejump to class

Details

$_sesionNamespacejump to class

Details

$_sessionjump to class

Details

$_sessionNamejump to class

Details

$_tablejump to class

Details

Methods

__constructjump to class

Details

_buildDispatchTablejump to class

Details

_checkAcljump to class

Arguments

Output

Details

_dispatchjump to class

Arguments

Output

Details

_errorMessagejump to class

Arguments

Output

Details

_handlejump to class

Arguments

Output

Details

_handleAuthjump to class

Arguments

Output

Details

_loadCommandMessagejump to class

Arguments

Output

Details

addDirectoryjump to class

Arguments

Details

addFunctionjump to class

Arguments

Output

Details

faultjump to class

Arguments

Details

getAcljump to class

Output

Details

getAuthjump to class

Output

Details

getDirectoryjump to class

Output

Details

getFunctionsjump to class

Output

Zend_Amf_Server
jump to top

$_acl
jump to class

$_auth
jump to class

$_classAllowed
jump to class

$_loader
jump to class

$_methods
jump to class

$_production
jump to class

$_request
jump to class

$_response
jump to class

$_sesionNamespace
jump to class

$_session
jump to class

$_sessionName
jump to class

$_table
jump to class

__construct
jump to class

_buildDispatchTable
jump to class

_checkAcl
jump to class

_dispatch
jump to class

_errorMessage
jump to class

_handle
jump to class

_handleAuth
jump to class

_loadCommandMessage
jump to class

addDirectory
jump to class

addFunction
jump to class

fault
jump to class

getAcl
jump to class

getAuth
jump to class

getDirectory
jump to class

getFunctions
jump to class

getLoader
jump to class

getRequest
jump to class

getResponse
jump to class

handle
jump to class

isProduction
jump to class

isSession
jump to class

listMethods
jump to class

loadFunctions
jump to class

setAcl
jump to class

setAuth
jump to class

setClass
jump to class

setClassMap
jump to class

setPersistence
jump to class

setProduction
jump to class

setRequest
jump to class

setResponse
jump to class

setSession
jump to class