cvs: phpdoc /en/reference/simplexml/functions simplexml-element-asXML.xml

nlopess Tue Sep 6 12:21:54 2005 EDT Modified files: /phpdoc/en/reference/simplexml/functions simplexml-element-asXML.xml Log: upgrade to new style. document the 'filename' parameter http://cvs.php.net/diff.php/phpdoc/en/reference/simplexml/functions/simplexml-element-asXML.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/simplexml/functions/simplexml-element-asXML.xml diff -u phpdoc/en/reference/simplexml/functions/simplexml-element-asXML.xml:1.4 phpdoc/en/reference/simplexml/functions/simplexml-element-asXML.xml:1.5 --- phpdoc/en/reference/simplexml/functions/simplexml-element-asXML.xml:1.4 Fri Aug 20 05:37:00 2004 +++ phpdoc/en/reference/simplexml/functions/simplexml-element-asXML.xml Tue Sep 6 12:21:50 2005 @@ -1,26 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id='function.simplexml-element-asXML'> - <refnamediv> - <refname>SimpleXMLElement->asXML</refname> - <refpurpose> - Return a well-formed XML string based on SimpleXML element - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>SimpleXMLElement->asXML</methodname> - <void/> - </methodsynopsis> - <para> - The <literal>asXML</literal> method formats the parent object's data - in XML version 1.0. - </para> - <para> - <example> - <title>Get XML</title> - <programlisting role="php"> +<!-- $Revision: 1.5 $ --> +<refentry id='function.simplexml-element-asXML'> + <refnamediv> + <refname>SimpleXMLElement->asXML</refname> + <refpurpose> + Return a well-formed XML string based on SimpleXML element + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>mixed</type><methodname>SimpleXMLElement->asXML</methodname> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + <para> + The <literal>asXML</literal> method formats the parent object's data + in XML version 1.0. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + If specified, the function writes the data to the file rather than + returning it. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If the <parameter>filename</parameter> isn't specified, this function + returns a <type>string</type> on success and &false; on error. If the + parameter is specified, it returns &true; if the file was written + successfully and &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Get XML</title> + <programlisting role="php"> <![CDATA[ <?php $string = <<<XML @@ -41,18 +72,18 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - <literal>asXML</literal> also works on Xpath results: - <example> - <title> - Using asXML() on - <link linkend="function.simplexml-element-xpath">Xpath</link> - results - </title> - <programlisting role="php"> + </programlisting> + </example> + </para> + <para> + <literal>asXML</literal> also works on Xpath results: + <example> + <title> + Using asXML() on + <link linkend="function.simplexml-element-xpath">Xpath</link> + results + </title> + <programlisting role="php"> <![CDATA[ <?php // Continued from example XML above. @@ -65,11 +96,11 @@ } ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: