php-doc-en/reference/simplexml/functions/simplexml-load-string.xml

105 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id='function.simplexml-load-string'>
<refnamediv>
<refname>simplexml_load_string</refname>
<refpurpose>
Interprets a string of XML into an object
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>simplexml_load_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This function will take the well-formed xml string
<parameter>data</parameter> and return an <type>object</type> of class
<type>SimpleXMLElement</type> with properties containing the data held
within the xml document. If any errors occur, it returns &false;.
</para>
<para>
You may use the optional <parameter>class_name</parameter> parameter so
that <function>simplexml_load_string</function> will return an object of
the specified class. That class should extend the
<type>SimpleXMLElement</type> class.
</para>
<para>
Since PHP 5.1.0 and Libxml 2.6.0, you may also use the
<parameter>options</parameter> parameter to specify <link
linkend="libxml.constants">additional Libxml parameters</link>.
</para>
<para>
<example>
<title>Interpret an XML string</title>
<programlisting role="php">
<![CDATA[
<?php
$string = <<<XML
<?xml version='1.0'?>
<document>
<title>Forty What?</title>
<from>Joe</from>
<to>Jane</to>
<body>
I know that's the answer -- but what's the question?
</body>
</document>
XML;
$xml = simplexml_load_string($string);
var_dump($xml);
?>
]]>
</programlisting>
<para>
This script will display:
</para>
<screen>
<![CDATA[
SimpleXMLElement Object
(
[title] => Forty What?
[from] => Joe
[to] => Jane
[body] =>
I know that's the answer -- but what's the question?
)
]]>
</screen>
<simpara>
At this point, you can go about using <literal>$xml->body</literal>
and such.
</simpara>
</example>
</para>
<para>
See also: <function>simplexml_load_file</function>.
</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:"../../../../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
-->