X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=doc%2Fapi_changes_v4.md;h=57b4eb39ddeefb33b84edd5e1040b2b177c6cd0c;hb=593257683d9741b1cf1862dd421d244e90751d3a;hp=7b04ecd7ac85d8d1eae205c8d10f5fadb299de3a;hpb=bd4048215800186db5224ea04e0d45cab97c12b9;p=plcapi.git diff --git a/doc/api_changes_v4.md b/doc/api_changes_v4.md index 7b04ecd..57b4eb3 100644 --- a/doc/api_changes_v4.md +++ b/doc/api_changes_v4.md @@ -8,18 +8,18 @@ It is not necessary any more to include the files xmlrpc.inc, xmlrpcs.inc and xm library classes available. Instead, it is recommended to rely on class autoloading. - -* If you are using Composer, just install the library by declaring it as dependency for your project in composer.json + +* If you are using Composer, just install the library by declaring it as dependency for your project in composer.json "require": { ..., "phpxmlrpc/phpxmlrpc": "~4.0" }, - + * If you do not use Composer, an autoloader for the library can be found in src/Atuloader.php. The php example files in the demo/client folder do make use of it. Example code to set up the autoloader: - + include_once . "/src/Autoloader.php"; PhpXmlRpc\Autoloader::register(); @@ -32,7 +32,7 @@ New class naming ---------------- All classes have ben renamed, are now properly namespaced and follow the CamelCase naming convention. -Existing class methods and members have been preserved; all new method names follow camelCase. +Existing class methods and members have been preserved; all new method names follow camelCase. Conversion table: @@ -89,25 +89,25 @@ Some have been slightly changed. | Old function | New function | Notes | | -------------------------------- | ------------------------------------------- | ------------------------------------------------------ | | build_client_wrapper_code | none | | -| build_remote_method_wrapper_code | PhpXmlRpc\Wrapper::buildWrapMethodSource | signature changed | +| build_remote_method_wrapper_code | PhpXmlRpc\Wrapper->buildWrapMethodSource | signature changed | | decode_chunked | PhpXmlRpc\Helper\Http::decodeChunked | | | guess_encoding | PhpXmlRpc\Helper\XMLParser::guessEncoding | | | has_encoding | PhpXmlRpc\Helper\XMLParser::hasEncoding | | -| is_valid_charset | PhpXmlRpc\Helper\Charset::isValidCharset | | +| is_valid_charset | PhpXmlRpc\Helper\Charset->isValidCharset | this method is not static, you need a Charset obj | | iso8601_decode | PhpXmlRpc\Helper\Date::iso8601Decode | | | iso8601_encode | PhpXmlRpc\Helper\Date::iso8601Encode | | -| php_2_xmlrpc_type | PhpXmlRpc\Wrapper::php2XmlrpcType | | -| php_xmlrpc_decode | PhpXmlRpc\Encoder::decode | | -| php_xmlrpc_decode_xml | PhpXmlRpc\Encoder::decodeXml | | -| php_xmlrpc_encode | PhpXmlRpc\Encoder::encode | | -| wrap_php_class | PhpXmlRpc\Wrapper::wrapPhpClass | returns closures instead of function names by default | -| wrap_php_function | PhpXmlRpc\Wrapper::wrapPhpFunction | returns closures instead of function names by default | -| wrap_xmlrpc_method | PhpXmlRpc\Wrapper::wrapXmrlpcMethod | returns closures instead of function names by default | -| wrap_xmlrpc_server | PhpXmlRpc\Wrapper::wrapXmrlpcServer | returns closures instead of function names by default; | -| | | returns an array ready for usage in dispatch map | -| xmlrpc_2_php_type | PhpXmlRpc\Wrapper::Xmlrpc2phpType | | -| xmlrpc_debugmsg | PhpXmlRpc\Server::xmlrpc_debugmsg | | -| xmlrpc_encode_entitites | PhpXmlRpc\Helper\Charset::encodeEntitites | | +| php_2_xmlrpc_type | PhpXmlRpc\Wrapper->php2XmlrpcType | this method is not static, you need a Wrapper obj | +| php_xmlrpc_decode | PhpXmlRpc\Encoder->decode | this method is not static, you need an Encoder obj | +| php_xmlrpc_decode_xml | PhpXmlRpc\Encoder->decodeXml | this method is not static, you need an Encoder obj | +| php_xmlrpc_encode | PhpXmlRpc\Encoder->encode | this method is not static, you need an Encoder obj | +| wrap_php_class | PhpXmlRpc\Wrapper->wrapPhpClass | returns closures instead of function names by default | +| wrap_php_function | PhpXmlRpc\Wrapper->wrapPhpFunction | returns closures instead of function names by default | +| wrap_xmlrpc_method | PhpXmlRpc\Wrapper->wrapXmrlpcMethod | returns closures instead of function names by default | +| wrap_xmlrpc_server | PhpXmlRpc\Wrapper->wrapXmrlpcServer | returns closures instead of function names by default; | +| | | returns an array ready for usage in dispatch map | +| xmlrpc_2_php_type | PhpXmlRpc\Wrapper->Xmlrpc2phpType | this method is not static, you need a Wrapper obj | +| xmlrpc_debugmsg | PhpXmlRpc\Server->xmlrpc_debugmsg | | +| xmlrpc_encode_entitites | PhpXmlRpc\Helper\Charset->encodeEntitities | this method is not static, you need a Charset obj | Character sets and encoding @@ -137,9 +137,9 @@ Other * when serialize() is invoked on a response and its payload can not be serialized, an exception is thrown instead of ending all execution -* all error messages now mention the class and method which generated name +* all error messages now mention the class and method which generated them -* all library source code has been moved to the src/ directory +* all library source code has been moved to the src/ directory * all source code has been reformatted according to modern PSR standards @@ -173,7 +173,7 @@ Below is the list of all known changes and possible pitfalls when enabling 'comp ### Usage of global variables * ALL global variables which existed after including xmlrpc.inc in version 3 still do exist after including it in v. 4 - + * Code which relies on using (as in 'reading') their value will keep working unchanged * Changing the value of some of those variables does not have any effect anymore on library operation. @@ -204,9 +204,9 @@ Below is the list of all known changes and possible pitfalls when enabling 'comp $GLOBALS['xmlrpc_null_apache_encoding'] = true; // new line needed now PhpXmlRpc\PhpXmlRpc::importGlobals(); - + Alternative solution: - + include('xmlrpc.inc'); PhpXmlRpc\PhpXmlRpc::$xmlrpc_null_apache_encoding = true; @@ -228,7 +228,7 @@ Below is the list of all known changes and possible pitfalls when enabling 'comp instances will return the new classes. Example: - + is_a(php_xmlrpc_encode('hello world'), 'xmlrpcval') => false is_a(php_xmlrpc_encode('hello world'), 'PhpXmlRpc\Value') => true