diff --git a/reference/xmlrpc/book.xml b/reference/xmlrpc/book.xml new file mode 100644 index 0000000..88a3901 --- /dev/null +++ b/reference/xmlrpc/book.xml @@ -0,0 +1,47 @@ + + + + + + XML-RPC + + + + &reftitle.intro; + + These functions can be used to write XML-RPC servers and clients. + You can find more information about XML-RPC at + &url.xmlrpc;, and more + documentation on this extension and its functions at + &url.xmlrpc-epi;. + + &warn.experimental; + + + + &reference.xmlrpc.setup; + &reference.xmlrpc.reference; + + + + + diff --git a/reference/xmlrpc/configure.xml b/reference/xmlrpc/configure.xml new file mode 100644 index 0000000..06b7cae --- /dev/null +++ b/reference/xmlrpc/configure.xml @@ -0,0 +1,32 @@ + + +
+ &reftitle.install; + + XML-RPC support in PHP is not enabled by default. You will need to + use the configuration + option when compiling PHP to enable XML-RPC support. + +
+ + + diff --git a/reference/xmlrpc/functions/xmlrpc-decode-request.xml b/reference/xmlrpc/functions/xmlrpc-decode-request.xml new file mode 100644 index 0000000..35d1531 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-decode-request.xml @@ -0,0 +1,40 @@ + + + + + xmlrpc_decode_request + Decodes XML into native PHP types + + + &reftitle.description; + + mixedxmlrpc_decode_request + stringxml + stringmethod + stringencoding + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-decode.xml b/reference/xmlrpc/functions/xmlrpc-decode.xml new file mode 100644 index 0000000..ded1b7f --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-decode.xml @@ -0,0 +1,88 @@ + + + + + xmlrpc_decode + Decodes XML into native PHP types + + + &reftitle.description; + + mixedxmlrpc_decode + stringxml + stringencoding"iso-8859-1" + + &warn.experimental.func; + + + + &reftitle.parameters; + + + + xml + + + XML response returned by XMLRPC method. + + + + + encoding + + + Input encoding supported by iconv. + + + + + + + + + &reftitle.returnvalues; + + Returns either an array, or an integer, or a string, or a boolean according + to the response returned by the XMLRPC method. + + + + + &reftitle.examples; + + See example by xmlrpc_encode_request. + + + + + &reftitle.seealso; + + + xmlrpc_encode_request + xmlrpc_is_fault + + + + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-encode-request.xml b/reference/xmlrpc/functions/xmlrpc-encode-request.xml new file mode 100644 index 0000000..751079d --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-encode-request.xml @@ -0,0 +1,129 @@ + + + + + xmlrpc_encode_request + Generates XML for a method request + + + &reftitle.description; + + stringxmlrpc_encode_request + stringmethod + mixedparams + arrayoutput_options + + &warn.experimental.func; + + + + &reftitle.parameters; + + + + method + + + Name of the method to call. + + + + + params + + + Method parameters compatible with method signature. + + + + + output_options + + + Array specifying output options may contain (default values are + emphasised): + + output_type: php, xml + verbosity: no_white_space, newlines_only, pretty + escaping: cdata, non-ascii, non-print, markup + (may be a string with one value or an array with multiple values) + version: simple, xmlrpc, soap 1.1, auto + encoding: iso-8859-1, other character set supported by iconv + + + + + + + + + + &reftitle.returnvalues; + + Returns a string containing the XML representation of the request. + + + + + &reftitle.examples; + + + XMLRPC client functions example + + [ + 'method' => "POST", + 'header' => "Content-Type: text/xml", + 'content' => $request, + ] +]); +$file = file_get_contents("http://www.example.com/xmlrpc", false, $context); +$response = xmlrpc_decode($file); +if ($response && xmlrpc_is_fault($response)) { + trigger_error("xmlrpc: $response[faultString] ($response[faultCode])"); +} else { + print_r($response); +} +?> +]]> + + + + + + + &reftitle.seealso; + + + stream_context_create + file_get_contents + xmlrpc_decode + + + + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-encode.xml b/reference/xmlrpc/functions/xmlrpc-encode.xml new file mode 100644 index 0000000..75d1b54 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-encode.xml @@ -0,0 +1,38 @@ + + + + + xmlrpc_encode + Generates XML for a PHP value + + + &reftitle.description; + + stringxmlrpc_encode + mixedvalue + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-get-type.xml b/reference/xmlrpc/functions/xmlrpc-get-type.xml new file mode 100644 index 0000000..68c8547 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-get-type.xml @@ -0,0 +1,96 @@ + + + + + xmlrpc_get_type + Gets xmlrpc type for a PHP value + + + &reftitle.description; + + stringxmlrpc_get_type + mixedvalue + + &warn.experimental.func; + + This function is especially useful for base64 and datetime strings. + + + + + &reftitle.parameters; + + + + value + + + PHP value + + + + + + + + + &reftitle.returnvalues; + + Returns the XML-RPC type. + + + + + &reftitle.examples; + + + XML-RPC type example + + +]]> + + + + + + + &reftitle.seealso; + + + xmlrpc_set_type + + + + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-is-fault.xml b/reference/xmlrpc/functions/xmlrpc-is-fault.xml new file mode 100644 index 0000000..e56d15e --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-is-fault.xml @@ -0,0 +1,79 @@ + + + + + xmlrpc_is_fault + Determines if an array value represents an XMLRPC fault + + + &reftitle.description; + + boolxmlrpc_is_fault + arrayarg + + &warn.experimental.func; + + + + &reftitle.parameters; + + + + arg + + + Array returned by xmlrpc_decode. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the argument means fault, &false; otherwise. Fault + description is available in $arg["faultString"], fault + code is in $arg["faultCode"]. + + + + + &reftitle.examples; + + See example by xmlrpc_encode_request. + + + + + &reftitle.seealso; + + + xmlrpc_decode + + + + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml b/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml new file mode 100644 index 0000000..adc0e37 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml @@ -0,0 +1,38 @@ + + + + + xmlrpc_parse_method_descriptions + Decodes XML into a list of method descriptions + + + &reftitle.description; + + arrayxmlrpc_parse_method_descriptions + stringxml + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml b/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml new file mode 100644 index 0000000..7355ece --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml @@ -0,0 +1,39 @@ + + + + + xmlrpc_server_add_introspection_data + Adds introspection documentation + + + &reftitle.description; + + intxmlrpc_server_add_introspection_data + resourceserver + arraydesc + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml b/reference/xmlrpc/functions/xmlrpc-server-call-method.xml new file mode 100644 index 0000000..bafb7ca --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-server-call-method.xml @@ -0,0 +1,41 @@ + + + + + xmlrpc_server_call_method + Parses XML requests and call methods + + + &reftitle.description; + + stringxmlrpc_server_call_method + resourceserver + stringxml + mixeduser_data + arrayoutput_options + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-server-create.xml b/reference/xmlrpc/functions/xmlrpc-server-create.xml new file mode 100644 index 0000000..1fa8d5b --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-server-create.xml @@ -0,0 +1,38 @@ + + + + + xmlrpc_server_create + Creates an xmlrpc server + + + &reftitle.description; + + resourcexmlrpc_server_create + + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml b/reference/xmlrpc/functions/xmlrpc-server-destroy.xml new file mode 100644 index 0000000..d3ba8c6 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-server-destroy.xml @@ -0,0 +1,38 @@ + + + + + xmlrpc_server_destroy + Destroys server resources + + + &reftitle.description; + + boolxmlrpc_server_destroy + resourceserver + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml b/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml new file mode 100644 index 0000000..7c14b0f --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml @@ -0,0 +1,39 @@ + + + + + xmlrpc_server_register_introspection_callback + Register a PHP function to generate documentation + + + &reftitle.description; + + boolxmlrpc_server_register_introspection_callback + resourceserver + stringfunction + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml b/reference/xmlrpc/functions/xmlrpc-server-register-method.xml new file mode 100644 index 0000000..d45f440 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-server-register-method.xml @@ -0,0 +1,40 @@ + + + + + xmlrpc_server_register_method + Register a PHP function to resource method matching method_name + + + &reftitle.description; + + boolxmlrpc_server_register_method + resourceserver + stringmethod_name + stringfunction + + &warn.experimental.func; + &warn.undocumented.func; + + + + diff --git a/reference/xmlrpc/functions/xmlrpc-set-type.xml b/reference/xmlrpc/functions/xmlrpc-set-type.xml new file mode 100644 index 0000000..c64a2b5 --- /dev/null +++ b/reference/xmlrpc/functions/xmlrpc-set-type.xml @@ -0,0 +1,116 @@ + + + + + xmlrpc_set_type + Sets xmlrpc type, base64 or datetime, for a PHP string value + + + &reftitle.description; + + boolxmlrpc_set_type + stringvalue + stringtype + + + Sets xmlrpc type, base64 or datetime, for a PHP string value. + + &warn.experimental.func; + + + + &reftitle.parameters; + + + + value + + + Value to set the type + + + + + type + + + 'base64' or 'datetime' + + + + + + + + + &reftitle.returnvalues; + + &return.success; + If successful, value is converted to an object. + + + + + &reftitle.errors; + + Issues E_WARNING with type unsupported by XMLRPC. + + + + + &reftitle.examples; + + + A <function>xmlrpc_set_type</function> example + + + + +]]> + + &example.outputs.similar; + + + + + + 20090322T23:43:03 + + + +]]> + + + + + + + + diff --git a/reference/xmlrpc/reference.xml b/reference/xmlrpc/reference.xml new file mode 100644 index 0000000..d6ae685 --- /dev/null +++ b/reference/xmlrpc/reference.xml @@ -0,0 +1,31 @@ + + + + + XML-RPC &Functions; + +&reference.xmlrpc.entities.functions; + + + + + diff --git a/reference/xmlrpc/setup.xml b/reference/xmlrpc/setup.xml new file mode 100644 index 0000000..ecc7111 --- /dev/null +++ b/reference/xmlrpc/setup.xml @@ -0,0 +1,50 @@ + + + + + &reftitle.setup; + + +
+ &reftitle.required; + &libxml.required; +
+ + + + &reference.xmlrpc.configure; + + + +
+ &reftitle.resources; + + This extension defines a XML-RPC server resource returned by + xmlrpc_server_create. + +
+ + +
+ + + diff --git a/reference/xmlrpc/versions.xml b/reference/xmlrpc/versions.xml new file mode 100644 index 0000000..7c4824b --- /dev/null +++ b/reference/xmlrpc/versions.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + +