mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-30 15:58:55 +00:00
ea1e3be13a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@311775 c90b9560-bf6c-de11-be94-00142212c4b1
151 lines
3.1 KiB
XML
151 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="simplexmlelement.asxml" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>SimpleXMLElement::asXML</refname>
|
|
<refpurpose>
|
|
Return a well-formed XML string based on SimpleXML element
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <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
|
|
<a>
|
|
<b>
|
|
<c>text</c>
|
|
<c>stuff</c>
|
|
</b>
|
|
<d>
|
|
<c>code</c>
|
|
</d>
|
|
</a>
|
|
XML;
|
|
|
|
$xml = new SimpleXMLElement($string);
|
|
|
|
echo $xml->asXML();
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
<?xml version="1.0"?>
|
|
<a>
|
|
<b>
|
|
<c>text</c>
|
|
<c>stuff</c>
|
|
</b>
|
|
<d>
|
|
<c>code</c>
|
|
</d>
|
|
</a>
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<literal>asXML</literal> also works on Xpath results:
|
|
<example>
|
|
<title>Using asXML() on <methodname>SimpleXMLElement::xpath</methodname> results</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Continued from example XML above.
|
|
|
|
/* Search for <a><b><c> */
|
|
$result = $xml->xpath('/a/b/c');
|
|
|
|
while(list( , $node) = each($result)) {
|
|
echo $node->asXML();
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
<c>text</c><c>stuff</c>
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><xref linkend="simplexml.examples-basic"/></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/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
|
|
-->
|