[Amfphp_Core] element index

Package indexes

• Amfphp_Core_Amf
• Amfphp_Core_Amf_Types
• Amfphp_Core_Common
• Amfphp
• Amfphp_Plugins_Authentication
• Amfphp_Plugins_CharsetConverter
• Amfphp_Plugins_CustomClassConverter
• Amfphp_Plugins_ErrorHandler
• Amfphp_Plugins_FlexMessaging
• Amfphp_Plugins_Get
• Amfphp_Plugins_Json
• Amfphp_Plugins_Logger
• AmfphpLogger
• Amfphp_Plugins_ServiceBrowser
• Amfphp_Services
• Amfphp_Examples_ExampleService
• Amfphp_Examples
• Tests_Amfphp_Core_Amf
• Tests_Amfphp_Core_Common
• Tests_Amfphp_Core
• Tests_Amfphp_Plugins_Authentication
• Tests_Amfphp_Plugins_CharsetConverter
• Tests_Amfphp_Plugins_CustomClassConverter
• Tests_Amfphp_Plugins_FlexMessaging
• Tests_Amfphp_Plugins_Logger
• Tests
• Tests_TestData
• Tests_TestData_CustomClasses
• Tests_TestData_Services
• Tests_TestData_TestPlugins_DisabledPlugin
• Tests_TestData_TestPlugins_DummyPlugin

__construct

Amfphp_Core_PluginManager::__construct() in PluginManager.php

constructor

__construct

Amfphp_Core_Gateway::__construct() in Gateway.php

constructor

__construct

Amfphp_Core_FilterManager::__construct() in FilterManager.php

constructor

__construct

Amfphp_Core_Config::__construct() in Config.php

addFilter

Amfphp_Core_FilterManager::addFilter() in FilterManager.php

register an object method for the given filter

Amfphp_Core_Config

Amfphp_Core_Config in Config.php

responsable for loading and maintaining Amfphp configuration

Amfphp_Core_Exception

Amfphp_Core_Exception in Exception.php

just a type to distinguish between Amfphp exceptions and any other exceptions

Amfphp_Core_FilterManager

Amfphp_Core_FilterManager in FilterManager.php

This class is a kind of event dispatcher

Amfphp_Core_Gateway

Amfphp_Core_Gateway in Gateway.php

where everything comes together in amfphp.

Amfphp_Core_HttpRequestGatewayFactory

Amfphp_Core_HttpRequestGatewayFactory in HttpRequestGatewayFactory.php

A gateway factory's job is to create a gateway. There can be many gateway factories, but as such the only one for now is this one, which creates a gateway assuming that the data to be processed is in an http request and thus available through the usual php globals

Amfphp_Core_PluginManager

Amfphp_Core_PluginManager in PluginManager.php

Loads plugins for Amfphp. Plugins consist of a folder in the plugins folder. The folder and the class should all have the same name. The file containing the class should be named with the class name with the '.php' suffix added.

AMFPHP_ROOTPATH

AMFPHP_ROOTPATH in ClassLoader.php

include this to include amfphp note: this list could be generated. In the meantime maintain it manually.

$checkArgumentCount

Amfphp_Core_Config::$checkArgumentCount in Config.php

set to true if you want the service router to check if the number of arguments received by amfPHP matches with the method being called.

$config

Amfphp_Core_Gateway::$config in Gateway.php

config.

$contentType

Amfphp_Core_Gateway::$contentType in Gateway.php

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

ClassLoader.php

ClassLoader.php in ClassLoader.php

Config.php

Config.php in Config.php

callFilters

Amfphp_Core_FilterManager::callFilters() in FilterManager.php

call the functions registered for the given filter. There can be as many parameters as necessary, but only the first one can be changed and and returned by the callees.

CONFIG_RETURN_ERROR_DETAILS

Amfphp_Core_Config::CONFIG_RETURN_ERROR_DETAILS in Config.php

if true, there will be detailed information in the error messages, including confidential information like paths.

createGateway

Amfphp_Core_HttpRequestGatewayFactory::createGateway() in HttpRequestGatewayFactory.php

create the gateway.

$disabledPlugins

Amfphp_Core_Config::$disabledPlugins in Config.php

array of plugins that are available but should be disabled

Exception.php

Exception.php in Exception.php

$filtersArray

Amfphp_Core_FilterManager::$filtersArray in FilterManager.php

registered filters

FilterManager.php

FilterManager.php in FilterManager.php

FILTER_DESERIALIZED_REQUEST

Amfphp_Core_Gateway::FILTER_DESERIALIZED_REQUEST in Gateway.php

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

FILTER_DESERIALIZED_REQUEST_HANDLER

Amfphp_Core_Gateway::FILTER_DESERIALIZED_REQUEST_HANDLER in Gateway.php

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

FILTER_DESERIALIZED_RESPONSE

Amfphp_Core_Gateway::FILTER_DESERIALIZED_RESPONSE in Gateway.php

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

FILTER_DESERIALIZER

Amfphp_Core_Gateway::FILTER_DESERIALIZER in Gateway.php

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

FILTER_EXCEPTION_HANDLER

Amfphp_Core_Gateway::FILTER_EXCEPTION_HANDLER in Gateway.php

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

FILTER_HEADERS

Amfphp_Core_Gateway::FILTER_HEADERS in Gateway.php

filter called to get the headers

FILTER_SERIALIZED_REQUEST

Amfphp_Core_Gateway::FILTER_SERIALIZED_REQUEST in Gateway.php

filter called when the serialized request comes in.

FILTER_SERIALIZED_RESPONSE

Amfphp_Core_Gateway::FILTER_SERIALIZED_RESPONSE in Gateway.php

filter called when the packet response is ready and serialized.

FILTER_SERIALIZER

Amfphp_Core_Gateway::FILTER_SERIALIZER in Gateway.php

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

FILTER_SERVICE_FOLDER_PATHS

Amfphp_Core_Gateway::FILTER_SERVICE_FOLDER_PATHS in Gateway.php

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

FILTER_SERVICE_NAMES_2_CLASS_FIND_INFO

Amfphp_Core_Gateway::FILTER_SERVICE_NAMES_2_CLASS_FIND_INFO in Gateway.php

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

$getData

Amfphp_Core_Gateway::$getData in Gateway.php

typically the $_GET array.

Gateway.php

Gateway.php in Gateway.php

getInstance

Amfphp_Core_FilterManager::getInstance() in FilterManager.php

getInstance

Amfphp_Core_PluginManager::getInstance() in PluginManager.php

gives access to the singleton

getRawPostData

Amfphp_Core_HttpRequestGatewayFactory::getRawPostData() in HttpRequestGatewayFactory.php

there seems to be some confusion in the php doc as to where best to get the raw post data from.

getResponseHeaders

Amfphp_Core_Gateway::getResponseHeaders() in Gateway.php

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

HttpRequestGatewayFactory.php

HttpRequestGatewayFactory.php in HttpRequestGatewayFactory.php

$instance

Amfphp_Core_PluginManager::$instance in PluginManager.php

protected instance of singleton

$instance

Amfphp_Core_FilterManager::$instance in FilterManager.php

protected instance of singleton

loadPlugins

Amfphp_Core_PluginManager::loadPlugins() in PluginManager.php

load the plugins

output

Amfphp_Core_Gateway::output() in Gateway.php

helper function for sending gateway data to output stream

$pluginInstances

Amfphp_Core_PluginManager::$pluginInstances in PluginManager.php

$pluginsConfig

Amfphp_Core_Config::$pluginsConfig in Config.php

array containing untyped plugin configuration data. Add as needed. The advised format is the name of the plugin as key, and then paramName/paramValue pairs as an array.

$pluginsFolders

Amfphp_Core_Config::$pluginsFolders in Config.php

paths to the folder containing the plugins. defaults to AMFPHP_ROOTPATH . '/Plugins/'

$postData

Amfphp_Core_Gateway::$postData in Gateway.php

typically the $_POST array.

PluginManager.php

PluginManager.php in PluginManager.php

$rawInputData

Amfphp_Core_Gateway::$rawInputData in Gateway.php

the serialized request

$rawOutputData

Amfphp_Core_Gateway::$rawOutputData in Gateway.php

the serialized response

$serviceFolderPaths

Amfphp_Core_Config::$serviceFolderPaths in Config.php

paths to folders containing services(relative or absolute)

$serviceNames2ClassFindInfo

Amfphp_Core_Config::$serviceNames2ClassFindInfo in Config.php

a dictionary of service classes represented in a ClassFindInfo.

$sharedConfig

Amfphp_Core_Config::$sharedConfig in Config.php

array containing configuration data that is shared between the plugins. The format is paramName/paramValue pairs as an array.

service

Amfphp_Core_Gateway::service() in Gateway.php

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