Migrate ext/xmlrpc to doc-extensions

reference/xmlrpc/book.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- State: deprecated -->
+
+<book xml:id="book.xmlrpc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <?phpdoc extension-membership="pecl" ?>
+ <title>XML-RPC</title>
+
+ <!-- {{{ preface -->
+ <preface xml:id="intro.xmlrpc">
+  &reftitle.intro;
+  <para>
+  These functions can be used to write XML-RPC servers and clients.
+  You can find more information about XML-RPC at
+  <link xlink:href="&url.xmlrpc;">&url.xmlrpc;</link>, and more
+  documentation on this extension and its functions at
+  <link xlink:href="&url.xmlrpc-epi;">&url.xmlrpc-epi;</link>.
+ </para>
+ &warn.experimental;
+ </preface>
+ <!-- }}} -->
+
+ &reference.xmlrpc.setup;
+ &reference.xmlrpc.reference;
+
+</book>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+

reference/xmlrpc/configure.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<section xml:id="xmlrpc.installation" xmlns="http://docbook.org/ns/docbook">
+ &reftitle.install;
+ <simpara>
+  XML-RPC support in PHP is not enabled by default. You will need to
+  use the <option role="configure">--with-xmlrpc[=DIR]</option> configuration
+  option when compiling PHP to enable XML-RPC support.
+ </simpara>
+</section>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+

reference/xmlrpc/functions/xmlrpc-decode-request.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.xmlrpc-decode-request" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>xmlrpc_decode_request</refname>
+  <refpurpose>Decodes XML into native PHP types</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>mixed</type><methodname>xmlrpc_decode_request</methodname>
+   <methodparam><type>string</type><parameter>xml</parameter></methodparam>
+   <methodparam><type>string</type><parameter role="reference">method</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+  </methodsynopsis>
+  &warn.experimental.func;
+  &warn.undocumented.func;
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

reference/xmlrpc/functions/xmlrpc-decode.xml

@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.xmlrpc-decode" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>xmlrpc_decode</refname>
+  <refpurpose>Decodes XML into native PHP types</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>mixed</type><methodname>xmlrpc_decode</methodname>
+   <methodparam><type>string</type><parameter>xml</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>"iso-8859-1"</initializer></methodparam>
+  </methodsynopsis>
+  &warn.experimental.func;
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>xml</parameter></term>
+     <listitem>
+      <para>
+       XML response returned by XMLRPC method.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>encoding</parameter></term>
+     <listitem>
+      <para>
+       Input encoding supported by iconv.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns either an array, or an integer, or a string, or a boolean according
+   to the response returned by the XMLRPC method.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   See example by <function>xmlrpc_encode_request</function>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>xmlrpc_encode_request</function></member>
+    <member><function>xmlrpc_is_fault</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

reference/xmlrpc/functions/xmlrpc-encode-request.xml

@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.xmlrpc-encode-request" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>xmlrpc_encode_request</refname>
+  <refpurpose>Generates XML for a method request</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>xmlrpc_encode_request</methodname>
+   <methodparam><type>string</type><parameter>method</parameter></methodparam>
+   <methodparam><type>mixed</type><parameter>params</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>output_options</parameter></methodparam>
+  </methodsynopsis>
+  &warn.experimental.func;
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>method</parameter></term>
+     <listitem>
+      <para>
+       Name of the method to call.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>params</parameter></term>
+     <listitem>
+      <para>
+       Method parameters compatible with method signature.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>output_options</parameter></term>
+     <listitem>
+      <para>
+       Array specifying output options may contain (default values are
+       emphasised):
+       <itemizedlist>
+        <listitem><para>output_type: php, <emphasis>xml</emphasis></para></listitem>
+        <listitem><para>verbosity: no_white_space, newlines_only, <emphasis>pretty</emphasis></para></listitem>
+        <listitem><para>escaping: cdata, <emphasis>non-ascii, non-print, markup</emphasis>
+          (may be a string with one value or an array with multiple values)</para></listitem>
+        <listitem><para>version: simple, <emphasis>xmlrpc</emphasis>, soap 1.1, auto</para></listitem>
+        <listitem><para>encoding: <emphasis>iso-8859-1</emphasis>, other character set supported by iconv</para></listitem>
+       </itemizedlist>
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a string containing the XML representation of the request.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>XMLRPC client functions example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$request = xmlrpc_encode_request("method", [1, 2, 3]);
+$context = stream_context_create([
+    'http' => [
+        '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);
+}
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>stream_context_create</function></member>
+    <member><function>file_get_contents</function></member>
+    <member><function>xmlrpc_decode</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

reference/xmlrpc/functions/xmlrpc-encode.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.xmlrpc-encode" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>xmlrpc_encode</refname>
+  <refpurpose>Generates XML for a PHP value</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>xmlrpc_encode</methodname>
+   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
+  </methodsynopsis>
+  &warn.experimental.func;
+  &warn.undocumented.func;
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->