File: simplexml-load-string.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (105 lines) | stat: -rw-r--r-- 2,885 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<?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
-->