cvs: peardoc /en/package/webservices/xml-rpc api.xml examples.xml intro.xml support.xml
| From: | Daniel Convissor | Date: | Tue, 13 Apr 2004 17:57:43 +0000 |
| Subject: | cvs: peardoc /en/package/webservices/xml-rpc api.xml examples.xml intro.xml support.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3337@lists.php.net to get a copy of this message | ||
danielc Tue Apr 13 13:57:43 2004 EDT
Modified files:
/peardoc/en/package/webservices/xml-rpc api.xml examples.xml
intro.xml support.xml
Log:
Whitespace fix: tabs to space, drop trailing whitespace.
http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/api.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/api.xml diff -u peardoc/en/package/webservices/xml-rpc/api.xml:1.1 peardoc/en/package/webservices/xml-rpc/api.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/api.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/api.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $revision: 1.3 $ --> +e<!-- $revision: 1.3 $ --> <refentry id="package.webservices.xml-rpc.api"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1 id="package.webservices.xml-rpc.api.client"> <title>XML_RPC_Client</title> <para> - This is the basic class used to represent a client of an XML-RPC + This is the basic class used to represent a client of an XML-RPC server. </para> @@ -67,7 +67,7 @@ <paramdef><parameter>$server_method</parameter></paramdef> </funcprototype> </funcsynopsis> - + <para> Where <parameter>$xmlrpc_message</parameter> is an instance of <classname>XML_RPC_Message</classname> and @@ -75,7 +75,7 @@ <classname>XML_RPC_Response</classname> (see <xref linkend="package.webservices.xml-rpc.api.response" />). </para> - + <para> The <parameter>$timeout</parameter> is optional, and will be set to <literal>0</literal> (wait forever) if omitted. This timeout value @@ -131,7 +131,7 @@ <para> This method sets the username and password for authorizing the client to a server. With the default (HTTP) transport, this - information is used for HTTP Basic authorization. + information is used for HTTP Basic authorization. </para> </refsect3> @@ -165,9 +165,9 @@ installation of PHP. </para> - </refsect3> + </refsect3> - <refsect3> + <refsect3> <title>setSSLVerifyPeer</title> <funcsynopsis> @@ -221,7 +221,7 @@ print debugging information to the browser. The default is not to output this information. </para> - + <para> The debugging information includes the raw data returned from the XML-RPC server it was querying, and the PHP value the client @@ -243,7 +243,7 @@ server. A client sends an <classname>XML_RPC_Message</classname> to a server, and receives back an <classname>XML_RPC_Response</classname>. </para> - + <refsect2> <title>Creation</title> <para> @@ -400,7 +400,7 @@ </refsect1> <refsect1 id="package.webservices.xml-rpc.api.response" xreflabel="XML_RPC_Response"> - <title>XML_RPC_Response</title> + <title>XML_RPC_Response</title> <para> This class is used to contain responses to XML-RPC requests. A server method handler will construct an @@ -474,7 +474,7 @@ </refsect3> <refsect3> - <title>value</title> + <title>value</title> <funcsynopsis> <funcprototype> <funcdef>$xmlrpcVal = $resp->value</funcdef> @@ -506,7 +506,7 @@ </refsect1> <refsect1 id="package.webservices.xml-rpc.api.value" xreflabel="XML_RPC_Value"> - <title>XML_RPC_Value</title> + <title>XML_RPC_Value</title> <para> This is where a lot of the hard work gets done. This class enables @@ -562,7 +562,7 @@ <para> The characters <literal>< > "</literal> and <literal>&</literal> are converted to their entity equivalents - <literal>&lt; &gt; &quot;</literal> and + <literal>&lt; &gt; &quot;</literal> and <literal>&amp;</literal> for transport through XML-RPC. The current XML-RPC spec recommends only encoding <literal>< &</literal> but this implementation goes further, for reasons @@ -624,7 +624,7 @@ $myString= new XML_RPC_Value("Hello, World!", "string"); $myBool = new XML_RPC_Value(1, "boolean"); </programlisting> - + <para> The fourth constructor form can be used to compose complex XML-RPC values. The first argument is either a simple array in the case of @@ -646,6 +646,7 @@ </programlisting> </refsect2> + <refsect2 id="package.webservices.xml-rpc.api.value.methods" xreflabel="XML_RPC_Value methods"> <title>Methods</title> <refsect3> @@ -709,7 +710,7 @@ <parameter>$assocArrayVal</parameter>. See the fourth constructor form for more information. </para> - </refsect3> + </refsect3> <refsect3> <title>kindOf</title> @@ -733,7 +734,7 @@ <funcdef>$outString = $val->serialize</funcdef> <paramdef></paramdef> </funcprototype> - </funcsynopsis> + </funcsynopsis> <para> Returns a string containing the XML-RPC representation of this value. @@ -850,10 +851,10 @@ </refsect1> <refsect1 id="package.webservices.xml-rpc.api.server" xreflabel="XML_RPC_Server"> - <title>XML_RPC_Server</title> + <title>XML_RPC_Server</title> <para> The current implementation of this class has been kept as simple as - possible. The constructor for the server basically does all the + possible. The constructor for the server basically does all the work. Here's a minimal example: </para> @@ -949,7 +950,7 @@ Within a server's dispatch map, each method has an array of possible signatures. Each signature is an array of types. The first entry is the return type. For instance, the method <programlisting role="php"> - string examples.getStateName(int)</programlisting> has the signature + string examples.getStateName(int)</programlisting> has the signature <programlisting role="php">array($xmlrpcString, $xmlrpcInt)</programlisting> and, assuming that it the only possible signature for the method, might be used like this in server @@ -963,12 +964,12 @@ name of a US state, where the integer is the index of that state name in an alphabetic order.'; -$s = new XML_RPC_Server(array("examples.getStateName" => - array("function" => "findstate", - "signature" => $findstate_sig, - "docstring" => $findstate_doc))); +$s = new XML_RPC_Server(array("examples.getStateName" => + array("function" => "findstate", + "signature" => $findstate_sig, + "docstring" => $findstate_doc))); </programlisting> - + <para> For convenience the strings representing the XML-RPC types have been encoded as global variables: @@ -1095,8 +1096,8 @@ </variablelist> </refsect2> </refsect1> - </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -1115,5 +1116,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +--> http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/examples.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/examples.xml diff -u peardoc/en/package/webservices/xml-rpc/examples.xml:1.1 peardoc/en/package/webservices/xml-rpc/examples.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/examples.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/examples.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.webservices.xml-rpc.examples"> <refnamediv> @@ -31,8 +31,8 @@ $v = $response->value(); if (!$response->faultCode()) { - print "State number 42 is " . $v->scalarval() . "\n"; - print "I got this value back:\n" . $response->serialize() . "\n"; + print "State number 42 is " . $v->scalarval() . "\n"; + print "I got this value back:\n" . $response->serialize() . "\n"; } else { print "Fault: "; print "Code: " . $response->faultCode() . " Reason '" . $response->faultString() . "'\n"; @@ -40,8 +40,8 @@ ]]> </programlisting> </refsect1> - </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -60,5 +60,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +--> http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/intro.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/intro.xml diff -u peardoc/en/package/webservices/xml-rpc/intro.xml:1.1 peardoc/en/package/webservices/xml-rpc/intro.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/intro.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/intro.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.webservices.xml-rpc.intro"> <refnamediv> @@ -77,13 +77,13 @@ <glosslist> <glossentry> - <glossterm>Server.php</glossterm> - <glossdef> + <glossterm>Server.php</glossterm> + <glossdef> <para> the XML-RPC server class. <function>include</function> this to get server functionality. </para> - </glossdef> + </glossdef> </glossentry> <glossentry> <glossterm>RPC.php</glossterm> @@ -91,12 +91,14 @@ <para> the XML-RPC client classes. <function>include</function> this to get client functionality. - </para> + </para> </glossdef> </glossentry> </glosslist> + </refsect1> </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -115,5 +117,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +--> http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/support.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/support.xml diff -u peardoc/en/package/webservices/xml-rpc/support.xml:1.1 peardoc/en/package/webservices/xml-rpc/support.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/support.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/support.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.webservices.xml-rpc.support"> <refnamediv> @@ -14,7 +14,7 @@ commitment to support. However, informal advice and help is available via the PEAR user mailing list and XML-RPC.com. </para> - + <itemizedlist> <listitem> <para> @@ -38,7 +38,7 @@ XML-RPC. This group is also gatewayed into the Yahoo! Groups mailing list.</para> </listitem> - </itemizedlist> + </itemizedlist> </refsect1> <refsect1 id="package.webservices.xml-rpc.support.jellyfish"> @@ -46,7 +46,7 @@ <para> <graphic - fileref="http://www.oreilly.com/catalog/covers/progxmlrpc.s.gif" + fileref="http://www.oreilly.com/catalog/covers/progxmlrpc.s.gif" format="GIF" width="145" depth="190" align="right"></graphic> Together with Simon St.Laurent and Joe Johnston, Edd Dumbill wrote a book on XML-RPC for O'Reilly and Associates on XML-RPC. It features a @@ -68,8 +68,8 @@ software, then please consider buying the book! </para> </refsect1> - </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -88,5 +88,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +-->
http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/api.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/api.xml diff -u peardoc/en/package/webservices/xml-rpc/api.xml:1.1 peardoc/en/package/webservices/xml-rpc/api.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/api.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/api.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $revision: 1.3 $ --> +e<!-- $revision: 1.3 $ --> <refentry id="package.webservices.xml-rpc.api"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1 id="package.webservices.xml-rpc.api.client"> <title>XML_RPC_Client</title> <para> - This is the basic class used to represent a client of an XML-RPC + This is the basic class used to represent a client of an XML-RPC server. </para> @@ -67,7 +67,7 @@ <paramdef><parameter>$server_method</parameter></paramdef> </funcprototype> </funcsynopsis> - + <para> Where <parameter>$xmlrpc_message</parameter> is an instance of <classname>XML_RPC_Message</classname> and @@ -75,7 +75,7 @@ <classname>XML_RPC_Response</classname> (see <xref linkend="package.webservices.xml-rpc.api.response" />). </para> - + <para> The <parameter>$timeout</parameter> is optional, and will be set to <literal>0</literal> (wait forever) if omitted. This timeout value @@ -131,7 +131,7 @@ <para> This method sets the username and password for authorizing the client to a server. With the default (HTTP) transport, this - information is used for HTTP Basic authorization. + information is used for HTTP Basic authorization. </para> </refsect3> @@ -165,9 +165,9 @@ installation of PHP. </para> - </refsect3> + </refsect3> - <refsect3> + <refsect3> <title>setSSLVerifyPeer</title> <funcsynopsis> @@ -221,7 +221,7 @@ print debugging information to the browser. The default is not to output this information. </para> - + <para> The debugging information includes the raw data returned from the XML-RPC server it was querying, and the PHP value the client @@ -243,7 +243,7 @@ server. A client sends an <classname>XML_RPC_Message</classname> to a server, and receives back an <classname>XML_RPC_Response</classname>. </para> - + <refsect2> <title>Creation</title> <para> @@ -400,7 +400,7 @@ </refsect1> <refsect1 id="package.webservices.xml-rpc.api.response" xreflabel="XML_RPC_Response"> - <title>XML_RPC_Response</title> + <title>XML_RPC_Response</title> <para> This class is used to contain responses to XML-RPC requests. A server method handler will construct an @@ -474,7 +474,7 @@ </refsect3> <refsect3> - <title>value</title> + <title>value</title> <funcsynopsis> <funcprototype> <funcdef>$xmlrpcVal = $resp->value</funcdef> @@ -506,7 +506,7 @@ </refsect1> <refsect1 id="package.webservices.xml-rpc.api.value" xreflabel="XML_RPC_Value"> - <title>XML_RPC_Value</title> + <title>XML_RPC_Value</title> <para> This is where a lot of the hard work gets done. This class enables @@ -562,7 +562,7 @@ <para> The characters <literal>< > "</literal> and <literal>&</literal> are converted to their entity equivalents - <literal>&lt; &gt; &quot;</literal> and + <literal>&lt; &gt; &quot;</literal> and <literal>&amp;</literal> for transport through XML-RPC. The current XML-RPC spec recommends only encoding <literal>< &</literal> but this implementation goes further, for reasons @@ -624,7 +624,7 @@ $myString= new XML_RPC_Value("Hello, World!", "string"); $myBool = new XML_RPC_Value(1, "boolean"); </programlisting> - + <para> The fourth constructor form can be used to compose complex XML-RPC values. The first argument is either a simple array in the case of @@ -646,6 +646,7 @@ </programlisting> </refsect2> + <refsect2 id="package.webservices.xml-rpc.api.value.methods" xreflabel="XML_RPC_Value methods"> <title>Methods</title> <refsect3> @@ -709,7 +710,7 @@ <parameter>$assocArrayVal</parameter>. See the fourth constructor form for more information. </para> - </refsect3> + </refsect3> <refsect3> <title>kindOf</title> @@ -733,7 +734,7 @@ <funcdef>$outString = $val->serialize</funcdef> <paramdef></paramdef> </funcprototype> - </funcsynopsis> + </funcsynopsis> <para> Returns a string containing the XML-RPC representation of this value. @@ -850,10 +851,10 @@ </refsect1> <refsect1 id="package.webservices.xml-rpc.api.server" xreflabel="XML_RPC_Server"> - <title>XML_RPC_Server</title> + <title>XML_RPC_Server</title> <para> The current implementation of this class has been kept as simple as - possible. The constructor for the server basically does all the + possible. The constructor for the server basically does all the work. Here's a minimal example: </para> @@ -949,7 +950,7 @@ Within a server's dispatch map, each method has an array of possible signatures. Each signature is an array of types. The first entry is the return type. For instance, the method <programlisting role="php"> - string examples.getStateName(int)</programlisting> has the signature + string examples.getStateName(int)</programlisting> has the signature <programlisting role="php">array($xmlrpcString, $xmlrpcInt)</programlisting> and, assuming that it the only possible signature for the method, might be used like this in server @@ -963,12 +964,12 @@ name of a US state, where the integer is the index of that state name in an alphabetic order.'; -$s = new XML_RPC_Server(array("examples.getStateName" => - array("function" => "findstate", - "signature" => $findstate_sig, - "docstring" => $findstate_doc))); +$s = new XML_RPC_Server(array("examples.getStateName" => + array("function" => "findstate", + "signature" => $findstate_sig, + "docstring" => $findstate_doc))); </programlisting> - + <para> For convenience the strings representing the XML-RPC types have been encoded as global variables: @@ -1095,8 +1096,8 @@ </variablelist> </refsect2> </refsect1> - </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -1115,5 +1116,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +--> http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/examples.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/examples.xml diff -u peardoc/en/package/webservices/xml-rpc/examples.xml:1.1 peardoc/en/package/webservices/xml-rpc/examples.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/examples.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/examples.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.webservices.xml-rpc.examples"> <refnamediv> @@ -31,8 +31,8 @@ $v = $response->value(); if (!$response->faultCode()) { - print "State number 42 is " . $v->scalarval() . "\n"; - print "I got this value back:\n" . $response->serialize() . "\n"; + print "State number 42 is " . $v->scalarval() . "\n"; + print "I got this value back:\n" . $response->serialize() . "\n"; } else { print "Fault: "; print "Code: " . $response->faultCode() . " Reason '" . $response->faultString() . "'\n"; @@ -40,8 +40,8 @@ ]]> </programlisting> </refsect1> - </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -60,5 +60,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +--> http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/intro.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/intro.xml diff -u peardoc/en/package/webservices/xml-rpc/intro.xml:1.1 peardoc/en/package/webservices/xml-rpc/intro.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/intro.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/intro.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.webservices.xml-rpc.intro"> <refnamediv> @@ -77,13 +77,13 @@ <glosslist> <glossentry> - <glossterm>Server.php</glossterm> - <glossdef> + <glossterm>Server.php</glossterm> + <glossdef> <para> the XML-RPC server class. <function>include</function> this to get server functionality. </para> - </glossdef> + </glossdef> </glossentry> <glossentry> <glossterm>RPC.php</glossterm> @@ -91,12 +91,14 @@ <para> the XML-RPC client classes. <function>include</function> this to get client functionality. - </para> + </para> </glossdef> </glossentry> </glosslist> + </refsect1> </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -115,5 +117,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +--> http://cvs.php.net/diff.php/peardoc/en/package/webservices/xml-rpc/support.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/webservices/xml-rpc/support.xml diff -u peardoc/en/package/webservices/xml-rpc/support.xml:1.1 peardoc/en/package/webservices/xml-rpc/support.xml:1.2 --- peardoc/en/package/webservices/xml-rpc/support.xml:1.1 Sun Dec 21 09:24:40 2003 +++ peardoc/en/package/webservices/xml-rpc/support.xml Tue Apr 13 13:57:42 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.webservices.xml-rpc.support"> <refnamediv> @@ -14,7 +14,7 @@ commitment to support. However, informal advice and help is available via the PEAR user mailing list and XML-RPC.com. </para> - + <itemizedlist> <listitem> <para> @@ -38,7 +38,7 @@ XML-RPC. This group is also gatewayed into the Yahoo! Groups mailing list.</para> </listitem> - </itemizedlist> + </itemizedlist> </refsect1> <refsect1 id="package.webservices.xml-rpc.support.jellyfish"> @@ -46,7 +46,7 @@ <para> <graphic - fileref="http://www.oreilly.com/catalog/covers/progxmlrpc.s.gif" + fileref="http://www.oreilly.com/catalog/covers/progxmlrpc.s.gif" format="GIF" width="145" depth="190" align="right"></graphic> Together with Simon St.Laurent and Joe Johnston, Edd Dumbill wrote a book on XML-RPC for O'Reilly and Associates on XML-RPC. It features a @@ -68,8 +68,8 @@ software, then please consider buying the book! </para> </refsect1> - </refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -88,5 +88,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> - +-->