cvs: peardoc /en/package/xml xml-rddl.xml /en/package/xml/xml-rddl/xml-rddl getresourcebyid.xml

schst Sun Sep 14 15:39:43 2003 EDT Added files: /peardoc/en/package/xml/xml-rddl/xml-rddl getresourcebyid.xml Modified files: /peardoc/en/package/xml xml-rddl.xml Log: added documentation for XML_RDDL::getResourceById() Index: peardoc/en/package/xml/xml-rddl.xml diff -u peardoc/en/package/xml/xml-rddl.xml:1.2 peardoc/en/package/xml/xml-rddl.xml:1.3 --- peardoc/en/package/xml/xml-rddl.xml:1.2 Sun Sep 14 15:35:11 2003 +++ peardoc/en/package/xml/xml-rddl.xml Sun Sep 14 15:39:42 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <sect1 id="package.xml.xml-rddl"> <title>XML_RDDL</title> @@ -11,6 +11,7 @@ &package.xml.xml-rddl.xml-rddl.xml-rddl; &package.xml.xml-rddl.xml-rddl.parserddl; &package.xml.xml-rddl.xml-rddl.getallresources; + &package.xml.xml-rddl.xml-rddl.getresourcebyid; &package.xml.xml-rddl.xml-rddl.apiversion; </sect1> <!-- Keep this comment at the end of the file Index: peardoc/en/package/xml/xml-rddl/xml-rddl/getresourcebyid.xml +++ peardoc/en/package/xml/xml-rddl/xml-rddl/getresourcebyid.xml <!-- $Revision: 1.1 $ --> <refentry id="package.xml.xml-rddl.xml-rddl.getresourcebyid"> <refnamediv> <refname><function>XML_RDDL::getResourceByUd</function></refname> <refpurpose>get one resource from the document</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'XML/RDDL.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>XML_RDDL::getResourceById</function></funcdef> <paramdef>string <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.xml.xml-rddl.xml-rddl.getresourcebyid.desc"> &title.desc; <para> Gets one resource from a document. You have to call <link linkend="package.xml.xml-rddl.xml-rddl.parserddl">XML_RDDL::parseRDDL()</link> first. </para> </refsect1> <refsect1 id="package.default.xml-rddl.xml-rddl.getresourcebyid.param"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $id</parameter> - ID of the resource you want to get. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.xml.xml-rddl.xml-rddl.getresourcebyid.return"> &title.returns; <para> <emphasis>array</emphasis> array containing all information about the specified resource or a PEAR_Error if the resource does not exist. </para> </refsect1> <refsect1 id="package.xml.xml-rddl.xml-rddl.getresourcebyid.note"> &title.note; &note.notstatic; </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../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 -->