cvs: peardoc /en/package/xml/xml-sql2xml/xml-sql2xml add.xml addxmlfile.xml addxmlstring.xml getxml.xml getxmlobject.xml setoptions.xml
xml-sql2xml.xml

farell Sat Dec 27 13:35:39 2008 UTC Modified files: /peardoc/en/package/xml/xml-sql2xml/xml-sql2xml add.xml addxmlfile.xml addxmlstring.xml getxml.xml getxmlobject.xml setoptions.xml xml-sql2xml.xml Log: parameter initializer fixed (removed equal sign)

http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/add.xml?r1=1.6&r2=1.7&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/add.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/add.xml:1.6 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/add.xml:1.7 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/add.xml:1.6 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/add.xml Sat Dec 27 13:35:39 2008 @@ -11,17 +11,16 @@ </funcsynopsisinfo> <funcprototype> <funcdef>void <function>XML_sql2xml::add</function></funcdef> - + <paramdef choice="req"> string <parameter>$resultset</parameter> </paramdef> - + <paramdef choice="opt"> mixed <parameter>$params</parameter> - = <initializer>null</initializer> + <initializer>null</initializer> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -29,72 +28,72 @@ &title.desc; <para> General method for adding new result sets to the object. - Give a SQL statement, a PEAR::&class.db-result; object or an array as + Give a SQL statement, a PEAR::&class.db-result; object or an array as input parameter and the method calls the appropriate method for this input. </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.add.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>string $resultset</parameter> - SQL statement, an &class.db-result; object or an array </para> - </listitem> - + </listitem> + <listitem> <para> <parameter>mixed $params</parameter> - parameters for the following functions </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - - - + </refsection> + + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.add.note"> - &title.note; - + &title.note; + &note.notstatic; - - - + + + <simpara/> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.add.see"> - &title.see; + &title.see; <!-- Additional links go here --> <para> - - <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addresult">XML_sql2xml::addResult()</link>, - - <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addsql">XML_sql2xml::addSql()</link>, - - <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addarray">XML_sql2xml::addArray()</link>, - - <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addxmlfile">XML_sql2xml::addXmlFile()</link> - + + <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addresult">XML_sql2xml::addResult()</link>, + + <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addsql">XML_sql2xml::addSql()</link>, + + <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addarray">XML_sql2xml::addArray()</link>, + + <link linkend="package.xml.xml-sql2xml.xml-sql2xml.addxmlfile">XML_sql2xml::addXmlFile()</link> + </para> - </refsection> + </refsection> <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.add.example"> &title.example; <example><info><title>Using <function>add</function></title></info> - + <programlisting role="php"> - <![CDATA[ -$sql2xml->Add("select * from bands"); - ]]> + <![CDATA[ +$sql2xml->Add("select * from bands"); + ]]> </programlisting> </example> - </refsection> - </refentry> + </refsection> + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlfile.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlfile.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlfile.xml:1.5 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlfile.xml:1.6 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlfile.xml:1.5 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlfile.xml Sat Dec 27 13:35:39 2008 @@ -11,17 +11,16 @@ </funcsynopsisinfo> <funcprototype> <funcdef>void <function>XML_sql2xml::addXmlFile</function></funcdef> - + <paramdef choice="req"> string <parameter>$file</parameter> </paramdef> - + <paramdef choice="opt"> mixed <parameter>$xpath</parameter> - = <initializer>null</initializer> + <initializer>null</initializer> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -31,54 +30,54 @@ Adds the content of a XML file on the same level as a normal result set (mostly just below &lt;root&gt;). </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlfile.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>string $file</parameter> - file name </para> - </listitem> - + </listitem> + <listitem> <para> <parameter>mixed $xpath</parameter> - either a string with the XPath expression or an array with the keys - &quot;xpath&quot;=&gt;XPath expression and &quot;root&quot;=&gt;tag/subtag/etc, + &quot;xpath&quot;=&gt;XPath expression and &quot;root&quot;=&gt;tag/subtag/etc, which are the tags to be inserted before the result. </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - - - + </refsection> + + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlfile.note"> - &title.note; - + &title.note; + &note.notstatic; - - - + + + <simpara/> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlfile.see"> - &title.see; + &title.see; <!-- Additional links go here --> <para> <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>XML_sql2xml::add</function></link> - + </para> - </refsection> + </refsection> - </refentry> + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlstring.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlstring.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlstring.xml:1.5 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlstring.xml:1.6 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlstring.xml:1.5 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/addxmlstring.xml Sat Dec 27 13:35:39 2008 @@ -11,74 +11,73 @@ </funcsynopsisinfo> <funcprototype> <funcdef>void <function>XML_sql2xml::addXmlString</function></funcdef> - + <paramdef choice="req"> string <parameter>$string</parameter> </paramdef> - + <paramdef choice="opt"> mixed <parameter>$xpath</parameter> - = <initializer>null</initializer> + <initializer>null</initializer> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlstring.desc"> &title.desc; <para> - Adds the content of a xml-string on the same level + Adds the content of a xml-string on the same level as a normal result set (mostly just below &lt;root&gt;) </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlstring.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>string $string</parameter> - XML string </para> - </listitem> - + </listitem> + <listitem> <para> <parameter>mixed $xpath</parameter> - either a string with the XPath expression or an array with the keys - &quot;xpath&quot;=&gt;XPath expression + &quot;xpath&quot;=&gt;XPath expression and &quot;root&quot;=&gt;tag/subtag/etc, which are the tags to be inserted before the result. </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - - - + </refsection> + + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlstring.note"> - &title.note; - + &title.note; + &note.notstatic; - - - + + + <simpara/> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.addxmlstring.see"> - &title.see; + &title.see; <!-- Additional links go here --> <para> - + <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>XML_sql2xml::add</function></link> - + </para> - </refsection> - </refentry> + </refsection> + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxml.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxml.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxml.xml:1.5 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxml.xml:1.6 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxml.xml:1.5 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxml.xml Sat Dec 27 13:35:39 2008 @@ -11,13 +11,12 @@ </funcsynopsisinfo> <funcprototype> <funcdef>string <function>XML_sql2xml::getXML</function></funcdef> - + <paramdef choice="opt"> mixed <parameter>$result</parameter> - = <initializer>null</initializer> + <initializer>null</initializer> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -26,46 +25,46 @@ <para> Returns an XML string with a XML representation of the result set. The result set can be directly provided here, or if you need more than one - in your XML, then you have to provide each of them with <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>add</function></link> + in your XML, then you have to provide each of them with <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>add</function></link> before you call <function>getXML</function>, but the last one can also be provided here. </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.getxml.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>mixed $result</parameter> - a &class.db-result; object from a &class.db; query or a SQL query </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - + </refsection> + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.getxml.return"> &title.returns; <para> - <parameter>string</parameter> - the XML string + <parameter>string</parameter> - the XML string </para> - </refsection> - - - + </refsection> + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.getxml.note"> - &title.note; - + &title.note; + &note.notstatic; - - - + + + <simpara/> - </refsection> - - </refentry> + </refsection> + + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxmlobject.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxmlobject.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxmlobject.xml:1.5 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxmlobject.xml:1.6 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxmlobject.xml:1.5 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/getxmlobject.xml Sat Dec 27 13:35:39 2008 @@ -11,13 +11,12 @@ </funcsynopsisinfo> <funcprototype> <funcdef>Object <function>XML_sql2xml::getXMLObject</function></funcdef> - + <paramdef choice="opt"> mixed <parameter>$result</parameter> - = <initializer>null</initializer> + <initializer>null</initializer> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -25,49 +24,49 @@ &title.desc; <para> Returns an XML DomDocument object with a XML representation of the result sets. - The result set can be directly provided here, or if you need more than one + The result set can be directly provided here, or if you need more than one in your XML, then you have to provide each of them with <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>add</function></link> - before you call <function>getXMLObject</function>, + before you call <function>getXMLObject</function>, but the last one can also be provided here. </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.getxmlobject.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>mixed $result</parameter> - - a &class.db-result; object from a &class.db; query + a &class.db-result; object from a &class.db; query </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - + </refsection> + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.getxmlobject.return"> &title.returns; <para> - <parameter>Object</parameter> - DomDocument object + <parameter>Object</parameter> - DomDocument object </para> - </refsection> - - - + </refsection> + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.getxmlobject.note"> - &title.note; - + &title.note; + &note.notstatic; - - - + + + <simpara/> - </refsection> - + </refsection> + - </refentry> + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/setoptions.xml?r1=1.4&r2=1.5&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/setoptions.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/setoptions.xml:1.4 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/setoptions.xml:1.5 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/setoptions.xml:1.4 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/setoptions.xml Sat Dec 27 13:35:39 2008 @@ -11,17 +11,16 @@ </funcsynopsisinfo> <funcprototype> <funcdef>void <function>XML_sql2xml::setOptions</function></funcdef> - + <paramdef choice="req"> array <parameter>$options</parameter> </paramdef> - + <paramdef choice="opt"> constant <parameter>$delete</parameter> - = <initializer>false</initializer> + <initializer>false</initializer> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -30,13 +29,13 @@ <para> This method sets the options for the class instance. </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.setoptions.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>array $options</parameter> - @@ -46,46 +45,46 @@ <listitem> <para>boolean <parameter>$options['nested']</parameter> - if &true; the result of an join query will be nested. The default - value is &false;. + value is &false;. </para> </listitem> <listitem> <para>boolean <parameter>$options['tagNameRow']</parameter> - name for the row mark up tag. Default is &gt;row&lt; </para> - </listitem> + </listitem> <listitem> <para>boolean <parameter>$options['tagNameResult']</parameter> - name for the result-set mark up tag. Default is &gt;result&lt; </para> - </listitem> + </listitem> </itemizedlist> </para> - </listitem> - + </listitem> + <listitem> <para> <parameter>constant $delete</parameter> - the old sub options should be deleted </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - - - + </refsection> + + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.setoptions.note"> - &title.note; - + &title.note; + &note.notstatic; - - - + + + <simpara/> - </refsection> - + </refsection> + - </refentry> + </refentry> \ No newline at end of file http://cvs.php.net/viewvc.cgi/peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/xml-sql2xml.xml?r1=1.6&r2=1.7&diff_format=u Index: peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/xml-sql2xml.xml diff -u peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/xml-sql2xml.xml:1.6 peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/xml-sql2xml.xml:1.7 --- peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/xml-sql2xml.xml:1.6 Thu Oct 9 15:16:55 2008 +++ peardoc/en/package/xml/xml-sql2xml/xml-sql2xml/xml-sql2xml.xml Sat Dec 27 13:35:39 2008 @@ -11,17 +11,16 @@ </funcsynopsisinfo> <funcprototype> <funcdef>void <function>XML_sql2xml::XML_sql2xml</function></funcdef> - + <paramdef choice="opt"> mixed <parameter>$dsn</parameter> - = <initializer>null</initializer> + <initializer>null</initializer> </paramdef> - + <paramdef choice="opt"> string <parameter>$root="root"</parameter> </paramdef> - - + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -30,7 +29,7 @@ <para> The Constructor can take a Pear::DB <link linkend="package.database.db.intro-dsn">Data Source Name (DSN)</link> and will then connect to the database; or a PEAR::DB object handle, if you already connected the - database before. Providing sql-strings will not work. + database before. Providing sql-strings will not work. </para> <para> If you provide only a DSN, you have to <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add">add</link> @@ -38,66 +37,66 @@ </para> <para> The <parameter>$root</parameter> parameter is used, if you want to provide another name for your - root-tag than &lt;root&gt;. If you give an empty string (&quot;&quot;), there will be no + root-tag than &lt;root&gt;. If you give an empty string (&quot;&quot;), there will be no root element created here, but only when you add a resultset, array or SQL Statement. And the first tag of this result is used as the root tag. </para> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.xml-sql2xml.parameter"> &title.param; <para> <itemizedlist> - + <listitem> <para> <parameter>mixed $dsn</parameter> - PEAR::DB &quot;data source name&quot; or &class.db-common; object </para> - </listitem> - + </listitem> + <listitem> <para> <parameter>string $root</parameter> - the name of the XML-root element. </para> - </listitem> - + </listitem> + </itemizedlist> </para> - </refsection> - - - - + </refsection> + + + + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.xml-sql2xml.note"> - &title.note; - + &title.note; + &note.canstatic; - - - + + + <simpara/> - </refsection> - + </refsection> + <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.xml-sql2xml.see"> - &title.see; + &title.see; <!-- Additional links go here --> <para> - <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>XML_sql2xml::add</function></link> + <link linkend="package.xml.xml-sql2xml.xml-sql2xml.add"><function>XML_sql2xml::add</function></link> </para> - </refsection> + </refsection> <refsection xml:id="package.xml.xml-sql2xml.xml-sql2xml.xml-sql2xml.example"> &title.example; <example><info><title>Using <function>XML_sql2xml</function></title></info> - + <programlisting role="php"> - <![CDATA[ + <![CDATA[ $sql2xml = new xml_sql2xml("mysql://root@localhost/xmltest"); -$sql2xml->Add("select * from bands"); -]]> +$sql2xml->Add("select * from bands"); +]]> </programlisting> </example> - </refsection> - </refentry> + </refsection> + </refentry> \ No newline at end of file