cvs: peardoc /en/guide/migrating/channels xmlrpcfunctions.xml
| From: | Greg Beaver | Date: | Mon, 28 Mar 2005 19:04:10 +0000 |
| Subject: | cvs: peardoc /en/guide/migrating/channels xmlrpcfunctions.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-5808@lists.php.net to get a copy of this message | ||
cellog Mon Mar 28 14:04:10 2005 EDT
Modified files:
/peardoc/en/guide/migrating/channels xmlrpcfunctions.xml
Log:
begin adding documentation for each xml-rpc function, so
if someone wants to write another server backend,
it is actually possible.
http://cvs.php.net/diff.php/peardoc/en/guide/migrating/channels/xmlrpcfunctions.xml?r1=1.1&r2=1.2&ty=u
Index: peardoc/en/guide/migrating/channels/xmlrpcfunctions.xml
diff -u peardoc/en/guide/migrating/channels/xmlrpcfunctions.xml:1.1
peardoc/en/guide/migrating/channels/xmlrpcfunctions.xml:1.2
--- peardoc/en/guide/migrating/channels/xmlrpcfunctions.xml:1.1 Sat Mar 26 00:58:20 2005
+++ peardoc/en/guide/migrating/channels/xmlrpcfunctions.xml Mon Mar 28 14:04:09 2005
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="guide.migrating.channels.xmlrpcfunctions">
<refnamediv>
<refname>XML-RPC functions</refname>
@@ -17,37 +17,44 @@
<itemizedlist>
<listitem>
<para>
- logintest - a stub function
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.logintest">logintest</link>
+ - a stub function
</para>
</listitem>
<listitem>
<para>
- package.getDownloadURL - retrieve a URL to download a package
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.getdownloadurl">package.getDownloadURL</link>
+ - retrieve a URL to download a package
</para>
</listitem>
<listitem>
<para>
- package.getDepDownloadURL - retrieve a URL to download a package dependency
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.getdepdownloadurl">package.getDepDownloadURL</link>
+ - retrieve a URL to download a package dependency
</para>
</listitem>
<listitem>
<para>
- package.info - retrieve information on a package
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.info">package.info</link>
+ - retrieve information on a package
</para>
</listitem>
<listitem>
<para>
- package.listAll - list all packages and verbose information on each package
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.listall">package.listAll</link>
+ - list all packages and verbose information on each package
</para>
</listitem>
<listitem>
<para>
- package.listLatestReleases - list all packages and their latest release versions
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.listlatestreleases">package.listLatestReleases</link>
+ - list all packages and their latest release versions
</para>
</listitem>
<listitem>
<para>
- package.search - search all packages for a match
+ <link
linkend="guide.migrating.channels.xmlrpcfunctions.search">package.search</link>
+ - search all packages for a match
</para>
</listitem>
</itemizedlist>
@@ -58,6 +65,136 @@
command to retrieve an official list of channels.
</para>
</refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.logintest">
+ <title>logintest</title>
+ <para>
+ The logintest xml-rpc function is called by the login command, and should return a boolean
+ &true;
+ </para>
+ </refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.getdownloadurl">
+ <title>package.getDownloadURL</title>
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>false|struct
<function>package.getDownloadURL</function></funcdef>
+ <paramdef>struct <parameter>packageinfo</parameter></paramdef>
+ <paramdef>string <parameter><optional>preferred_state =
stable</optional></parameter></paramdef>
+ <paramdef>(v1.1) string <parameter><optional>installed_version =
false</optional></parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ false|struct <parameter>packageinfo</parameter>
+ </term>
+ <listitem>
+ <para>
+ an array of format:
+ </para>
+ <para>
+ <![CDATA[
+array(
+ 'channel' => channel name (not used in pear),
+ 'package' => package name,
+ ['version' => specific version to retrieve,]
+ ['state' => specific state to retrieve,]
+ )
+ ]]>
+ </para>
+ <para>
+ if both version and state are set, the version index should be ignored.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>preferred_state = stable</parameter>
+ </term>
+ <listitem>
+ <para>
+ The client-side preferred_state. This should be used to exclude releases
+ that are too unstable.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>installed_version = false</parameter>
+ </term>
+ <listitem>
+ <para>
+ The current installed version of the package on the client-side. This will either
+ be a version string, or false if the package is not installed. Use this to
+ ensure that older versions are never returned (as defined by
+ version_compare(possible_version, installed_version, "<")).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>
+ The package.getDownloadURL function should return an array with either two or three
+ indexes.
+ <itemizedlist>
+ <listitem>
+ <para>
+ "version" => version of the release returned
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "info" => the complete package.xml contents from the release
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "url" => a URL from which to download this release. If no releases
+ exist that fit the constraints defined by preferred_state, installed_version,
+ and the version/state indices of packageinfo, then do not return this index, and
+ instead return the version and package.xml of the latest release.
+ </para>
+ <para>
+ The url entry should NOT append .tgz or .tar, but should be something like
+ "http://pear.php.net/get/PEAR-1.4.0"
instead of
+ "http://pear.php.net/get/PEAR-1.4.0.tgz"
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.getdepdownloadurl">
+ <title>package.getDepDownloadURL</title>
+ <para>
+ hi
+ </para>
+ </refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.info">
+ <title>package.info</title>
+ <para>
+ hi
+ </para>
+ </refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.listall">
+ <title>package.listAll</title>
+ <para>
+ hi
+ </para>
+ </refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.listlatestreleases">
+ <title>package.listLatestReleases</title>
+ <para>
+ hi
+ </para>
+ </refsect1>
+ <refsect1 id="guide.migrating.channels.xmlrpcfunctions.search">
+ <title>package.search</title>
+ <para>
+ hi
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: