| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
PHP-XMLRPC "wrapper" functions Generate stubs to transparently access xmlrpc methods as php functions and viceversa
| Author: | Gaetano Giunta |
| Copyright: | G. Giunta (C) 2006 |
| Version: | $Id: xmlrpc_wrappers.inc,v 1.10 2006/09/01 21:49:19 ggiunta Exp $ |
| File Size: | 818 lines (30 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| php_2_xmlrpc_type($phptype) X-Ref |
| Given a string defining a php type or phpxmlrpc type (loosely defined: strings accepted come from javadoc blocks), return corresponding phpxmlrpc type. NB: for php 'resource' types returns empty string, since resources cannot be serialized; for php class names returns 'struct', since php objects can be serialized as xmlrpc structs param: string $phptype return: string |
| xmlrpc_2_php_type($xmlrpctype) X-Ref |
| Given a string defining a phpxmlrpc type return corresponding php type. param: string $xmlrpctype return: string |
| wrap_php_function($funcname, $newfuncname='', $extra_options=array() X-Ref |
| Given a user-defined PHP function, create a PHP 'wrapper' function that can be exposed as xmlrpc method from an xmlrpc_server object and called from remote clients (as well as its corresponding signature info). Since php is a typeless language, to infer types of input and output parameters, it relies on parsing the javadoc-style comment block associated with the given function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64) in the @param tag is also allowed, if you need the php function to receive/send data in that particular format (note that base64 encoding/decoding is transparently carried out by the lib, while datetime vals are passed around as strings) Known limitations: - requires PHP 5.0.3 + - only works for user-defined functions, not for PHP internal functions (reflection does not support retrieving number/type of params for those) - functions returning php objects will generate special xmlrpc responses: when the xmlrpc decoding of those responses is carried out by this same lib, using the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt. In short: php objects can be serialized, too (except for their resource members), using this function. Other libs might choke on the very same xml that will be generated in this case (i.e. it has a nonstandard attribute on struct element tags) - usage of javadoc @param tags using param names in a different order from the function prototype is not considered valid (to be fixed?) Note that since rel. 2.0RC3 the preferred method to have the server call 'standard' php functions (ie. functions not expecting a single xmlrpcmsg obj as parameter) is by making use of the functions_parameters_type class member. param: string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') might be ok too, in the future... param: string $newfuncname (optional) name for function to be created param: array $extra_options (optional) array of options for conversion. valid values include: return: false on error, or an array containing the name of the new php function, |
| wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='') X-Ref |
| Given an xmlrpc client and a method name, register a php wrapper function that will call it and return results using native php types for both params and results. The generated php function will return an xmlrpcresp oject for failed xmlrpc calls Known limitations: - server must support system.methodsignature for the wanted xmlrpc method - for methods that expose many signatures, only one can be picked (we could in priciple check if signatures differ only by number of params and not by type, but it would be more complication than we can spare time) - nested xmlrpc params: the caller of the generated php function has to encode on its own the params passed to the php function if these are structs or arrays whose (sub)members include values of type datetime or base64 Notes: the connection properties of the given client will be copied and reused for the connection used during the call to the generated php function. Calling the generated php function 'might' be slow: a new xmlrpc client is created on every invocation and an xmlrpc-connection opened+closed. An extra 'debug' param is appended to param list of xmlrpc method, useful for debugging purposes. param: xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server param: string $methodname the xmlrpc method to be mapped to a php function param: array $extra_options array of options that specify conversion details. valid ptions include return: string the name of the generated php function (or false) - OR AN ARRAY... |
| wrap_xmlrpc_server($client, $extra_options=array() X-Ref |
| Similar to wrap_xmlrpc_method, but will generate a php class that wraps all xmlrpc methods exposed by the remote server as own methods. For more details see wrap_xmlrpc_method. param: xmlrpc_client $client the client obj all set to query the desired server param: array $extra_options list of options for wrapped code return: mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options) |
| build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname,$msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc',$decode_php_objects=false, $encode_php_objects=false, $decode_fault=false,$fault_response='') X-Ref |
| Given the necessary info, build php code that creates a new function to invoke a remote xmlrpc method. Take care that no full checking of input parameters is done to ensure that valid php code is emitted. Note: real spaghetti code follows... |
| build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc') X-Ref |
| Given necessary info, generate php code that will rebuild a client object Take care that no full checking of input parameters is done to ensure that valid php code is emitted. |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |