API Documentation
\

\Amfphp_Core_Gateway

where everything comes together in amfphp.

The class used for the entry point of a remoting call

Summary

Methods
Properties
Constants
__construct()
service()
getResponseHeaders()
output()
No public properties found
FILTER_SERVICE_FOLDER_PATHS
FILTER_SERVICE_NAMES_2_CLASS_FIND_INFO
FILTER_SERIALIZED_REQUEST
FILTER_DESERIALIZER
FILTER_DESERIALIZED_REQUEST
FILTER_DESERIALIZED_REQUEST_HANDLER
FILTER_DESERIALIZED_RESPONSE
FILTER_EXCEPTION_HANDLER
FILTER_SERIALIZER
FILTER_SERIALIZED_RESPONSE
FILTER_HEADERS
FILTER_VO_CONVERTER
No protected methods found
$config
$getData
$postData
$contentType
$rawInputData
$rawOutputData
N/A
No private methods found
No private properties found
N/A

Constants

FILTER_SERVICE_FOLDER_PATHS

FILTER_SERVICE_FOLDER_PATHS

filter just after plugin init. Use this to add a service folder for a plugin

FILTER_SERVICE_NAMES_2_CLASS_FIND_INFO

FILTER_SERVICE_NAMES_2_CLASS_FIND_INFO

filter just after plugin init. Use this to add a service for a plugin when a service folder isn't enough

FILTER_SERIALIZED_REQUEST

FILTER_SERIALIZED_REQUEST

filter called when the serialized request comes in.

FILTER_DESERIALIZER

FILTER_DESERIALIZER

filter called to allow a plugin to override the default amf deserializer.

Plugin should return a Amfphp_Core_Common_IDeserializer if it recognizes the content type

FILTER_DESERIALIZED_REQUEST

FILTER_DESERIALIZED_REQUEST

filter called after the request is deserialized. The callee can modify the data and return it.

FILTER_DESERIALIZED_REQUEST_HANDLER

FILTER_DESERIALIZED_REQUEST_HANDLER

filter called to allow a plugin to override the default amf deserialized request handler.

Plugin should return a Amfphp_Core_Common_IDeserializedRequestHandler if it recognizes the request

FILTER_DESERIALIZED_RESPONSE

FILTER_DESERIALIZED_RESPONSE

filter called when the response is ready but not yet serialized. The callee can modify the data and return it.

FILTER_EXCEPTION_HANDLER

FILTER_EXCEPTION_HANDLER

filter called to allow a plugin to override the default amf exception handler.

If the plugin takes over the handling of the request message, it must set this to a proper Amfphp_Core_Common_IExceptionHandler

FILTER_SERIALIZER

FILTER_SERIALIZER

filter called to allow a plugin to override the default amf serializer.

FILTER_SERIALIZED_RESPONSE

FILTER_SERIALIZED_RESPONSE

filter called when the packet response is ready and serialized.

FILTER_HEADERS

FILTER_HEADERS

filter called to get the headers

FILTER_VO_CONVERTER

FILTER_VO_CONVERTER

filter Vo Converter note: this has nothing to do with the gateway. Filter definitions should one day be centralized in an independant place.

Properties

$getData

$getData : array

typically the $_GET array.

Type

array

$postData

$postData : array

typically the $_POST array.

Type

array

$contentType

$contentType : String

the content type. For example for amf, application/x-amf

Type

String

$rawInputData

$rawInputData : String

the serialized request

Type

String

$rawOutputData

$rawOutputData : String

the serialized response

Type

String

Methods

__construct()

__construct(array $getData, array $postData, String $rawInputData, String $contentType, \Amfphp_Core_Config $config)

constructor

Parameters

array $getData

typically the $_GET array.
array $postData

typically the $_POST array.
String $rawInputData
String $contentType
\Amfphp_Core_Config $config

optional. The default config object will be used if null

service()

service() : \<String>

The service method runs the gateway application. It deserializes the raw data passed into the constructor as an Amfphp_Core_Amf_Packet, handles the headers, handles the messages as requests to services, and returns the responses from the services It does not however handle output headers, gzip compression, etc. that is the job of the calling script

Returns

\ —

the serialized data

getResponseHeaders()

getResponseHeaders() : array

get the response headers. Creates an associative array of headers, then filters them, then returns an array of strings

Returns

array

output()

output()

helper function for sending gateway data to output stream