didou Tue Jan 16 01:05:33 2007 UTC
Modified files:
/phpdoc/en/reference/simplexml/functions
simplexml-element-addAttribute.xml
simplexml-element-attributes.xml
simplexml-element-children.xml
simplexml-element-construct.xml
simplexml-element-getName.xml
simplexml-element-getNamespaces.xml
simplexml-element-registerXPathNamespace.xml
simplexml-element-xpath.xml
simplexml-import-dom.xml
simplexml-load-file.xml
simplexml-load-string.xml
Log:
Fix new style implementation
Add missing sections / parameters
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-addAttribute.xml?r1=1.5&r2=1.6&diff_format=u
Index:
phpdoc/en/reference/simplexml/functions/simplexml-element-addAttribute.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-addAttribute.xml:1.5
phpdoc/en/reference/simplexml/functions/simplexml-element-addAttribute.xml:1.6
---
phpdoc/en/reference/simplexml/functions/simplexml-element-addAttribute.xml:1.5
Wed May 31 22:54:02 2006
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-addAttribute.xml
Tue Jan 16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id='function.simplexml-element-addAttribute'>
<refnamediv>
<refname>SimpleXMLElement->addAttribute()</refname>
@@ -55,6 +55,13 @@
</para>
</refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-attributes.xml?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-element-attributes.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-attributes.xml:1.8
phpdoc/en/reference/simplexml/functions/simplexml-element-attributes.xml:1.9
---
phpdoc/en/reference/simplexml/functions/simplexml-element-attributes.xml:1.8
Mon Jan 15 23:53:55 2007
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-attributes.xml
Tue Jan 16 01:05:32 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<refentry id='function.simplexml-element-attributes'>
<refnamediv>
<refname>SimpleXMLElement->attributes()</refname>
<refpurpose>Identifies an element's attributes</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
@@ -19,6 +20,40 @@
This function provides the attributes and values defined within an xml tag.
</para>
&simplexml.iteration;
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>ns</parameter></term>
+ <listitem>
+ <para>
+ An optional namespace for the retrieved attributes
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>is_prefix</parameter></term>
+ <listitem>
+ <para>
+ Default to &false;
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Interpret an XML string</title>
@@ -26,7 +61,7 @@
<![CDATA[
<?php
$string = <<<XML
-<a>
+<a xmlns:b>
<foo name="one" game="lonely">1</foo>
</a>
XML;
@@ -38,9 +73,7 @@
?>
]]>
</programlisting>
- <para>
- This script will display:
- </para>
+ &example.outputs;
<screen>
<![CDATA[
name="one"
@@ -50,6 +83,7 @@
</example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-children.xml?r1=1.10&r2=1.11&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-element-children.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-children.xml:1.10
phpdoc/en/reference/simplexml/functions/simplexml-element-children.xml:1.11
--- phpdoc/en/reference/simplexml/functions/simplexml-element-children.xml:1.10
Mon Jan 15 23:53:55 2007
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-children.xml
Tue Jan 16 01:05:32 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry id='function.simplexml-element-children'>
<refnamediv>
<refname>SimpleXMLElement->children()</refname>
<refpurpose>Finds children of given node</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
@@ -20,9 +21,43 @@
follows normal iteration rules.
</para>
&simplexml.iteration;
- <example>
- <title>Traversing a <literal>children()</literal> pseudo-array</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>ns</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>is_prefix</parameter></term>
+ <listitem>
+ <para>
+ Default to &false;
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Traversing a <literal>children()</literal> pseudo-array</title>
+ <programlisting role="php">
<![CDATA[
<?php
$xml = new SimpleXMLElement(
@@ -51,18 +86,18 @@
}
?>
]]>
- </programlisting>
- <simpara>
- This script will output:
- </simpara>
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
The person begot a son who begot a daughter; The person
begot a daughter who begot a son; and that son begot a son
]]>
- </screen>
- </example>
+ </screen>
+ </example>
+ </para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-construct.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-element-construct.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-construct.xml:1.2
phpdoc/en/reference/simplexml/functions/simplexml-element-construct.xml:1.3
--- phpdoc/en/reference/simplexml/functions/simplexml-element-construct.xml:1.2
Thu Jun 1 00:00:49 2006
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-construct.xml
Tue Jan 16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.simplexml-element-construct'>
<refnamediv>
<refname>SimpleXMLElement->__construct()</refname>
@@ -21,7 +21,7 @@
</constructorsynopsis>
</classsynopsis>
<para>
- Creates a new <classname>SimpleXMLElement</classname> object
+ Creates a new <classname>SimpleXMLElement</classname> object.
</para>
</refsect1>
@@ -57,6 +57,20 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>ns</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>is_prefix</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-getName.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-element-getName.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-getName.xml:1.5
phpdoc/en/reference/simplexml/functions/simplexml-element-getName.xml:1.6
--- phpdoc/en/reference/simplexml/functions/simplexml-element-getName.xml:1.5
Wed May 31 22:54:02 2006
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-getName.xml
Tue Jan 16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id='function.simplexml-element-getName'>
<refnamediv>
<refname>SimpleXMLElement->getName()</refname>
@@ -51,6 +51,7 @@
</example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-getNamespaces.xml?r1=1.7&r2=1.8&diff_format=u
Index:
phpdoc/en/reference/simplexml/functions/simplexml-element-getNamespaces.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-getNamespaces.xml:1.7
phpdoc/en/reference/simplexml/functions/simplexml-element-getNamespaces.xml:1.8
---
phpdoc/en/reference/simplexml/functions/simplexml-element-getNamespaces.xml:1.7
Thu Jun 22 03:04:35 2006
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-getNamespaces.xml
Tue Jan 16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<refentry id='function.simplexml-element-getNamespaces'>
<refnamediv>
<refname>SimpleXMLElement->getNamespaces()</refname>
@@ -65,13 +65,13 @@
$sxe = new SimpleXMLElement($xml);
-$namespaces = $sxe->getNamespaces(TRUE);
+$namespaces = $sxe->getNamespaces(true);
var_dump($namespaces);
?>
]]>
</programlisting>
- &example.outputs.similar;
+ &example.outputs;
<screen>
<![CDATA[
array(1) {
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-registerXPathNamespace.xml?r1=1.1&r2=1.2&diff_format=u
Index:
phpdoc/en/reference/simplexml/functions/simplexml-element-registerXPathNamespace.xml
diff -u
phpdoc/en/reference/simplexml/functions/simplexml-element-registerXPathNamespace.xml:1.1
phpdoc/en/reference/simplexml/functions/simplexml-element-registerXPathNamespace.xml:1.2
---
phpdoc/en/reference/simplexml/functions/simplexml-element-registerXPathNamespace.xml:1.1
Thu Jun 22 03:04:35 2006
+++
phpdoc/en/reference/simplexml/functions/simplexml-element-registerXPathNamespace.xml
Tue Jan 16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id='function.simplexml-element-registerXPathNamespace'>
<refnamediv>
<refname>SimpleXMLElement->registerXPathNamespace()</refname>
@@ -54,6 +54,13 @@
</para>
</refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -88,8 +95,7 @@
$sxe->registerXPathNamespace('c', 'http://example.org/chapter-title');
$result = $sxe->xpath('//c:title');
-foreach ($result as $title)
-{
+foreach ($result as $title) {
echo $title . "\n";
}
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-element-xpath.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-element-xpath.xml
diff -u phpdoc/en/reference/simplexml/functions/simplexml-element-xpath.xml:1.6
phpdoc/en/reference/simplexml/functions/simplexml-element-xpath.xml:1.7
--- phpdoc/en/reference/simplexml/functions/simplexml-element-xpath.xml:1.6
Mon Jan 15 23:53:55 2007
+++ phpdoc/en/reference/simplexml/functions/simplexml-element-xpath.xml Tue Jan
16 01:05:32 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<refentry id='function.simplexml-element-xpath'>
<refnamediv>
<refname>SimpleXMLElement->xpath()</refname>
<refpurpose>Runs XPath query on XML data</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
@@ -17,8 +18,34 @@
<para>
The <literal>xpath</literal> method searches the SimpleXML node for
children matching the <acronym>XPath</acronym> <parameter>path</parameter>.
- It always returns an <type>array</type> of SimpleXMLElement objects.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <para>
+ An XPath path
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Always returns an <type>array</type> of SimpleXMLElement objects.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Xpath</title>
@@ -55,9 +82,7 @@
?>
]]>
</programlisting>
- <para>
- This script will display:
- </para>
+ &example.outputs;
<screen>
<![CDATA[
/a/b/c: text
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-import-dom.xml?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-import-dom.xml
diff -u phpdoc/en/reference/simplexml/functions/simplexml-import-dom.xml:1.9
phpdoc/en/reference/simplexml/functions/simplexml-import-dom.xml:1.10
--- phpdoc/en/reference/simplexml/functions/simplexml-import-dom.xml:1.9
Mon Jan 15 23:53:55 2007
+++ phpdoc/en/reference/simplexml/functions/simplexml-import-dom.xml Tue Jan
16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<refentry id='function.simplexml-import-dom'>
<refnamediv>
<refname>simplexml_import_dom</refname>
@@ -13,20 +13,55 @@
<methodparam
choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
</methodsynopsis>
<para>
- <!-- same with this link -->
This function takes a node of a <link linkend="ref.dom">DOM</link>
document and makes it into a SimpleXML node. This new object can
- then be used as a native SimpleXML element. If any errors occur,
- it returns &false;.
+ then be used as a native SimpleXML element.
</para>
- <!-- php5 DOM isn't documented; this depends on it... :| -->
- <!-- TODO: Document class_name and when it appeared. -->
- <example>
- <title>Import DOM</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>node</parameter></term>
+ <listitem>
+ <para>
+ A <link linkend="ref.dom">DOM</link> Element node
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>class_name</parameter></term>
+ <listitem>
+ <para>
+ You may use this optional 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <type>SimpleXMLElement</type> or &false; on failure.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Importing DOM</title>
+ <programlisting role="php">
<![CDATA[
<?php
-$dom = new domDocument;
+$dom = new DOMDocument;
$dom->loadXML('<books><book><title>blah</title></book></books>');
if (!$dom) {
echo 'Error while parsing the document';
@@ -38,13 +73,20 @@
echo $s->book[0]->title; // blah
?>
]]>
- </programlisting>
- </example>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also
- <function>dom_import_simplexml</function>.
+ <simplelist>
+ <member><function>dom_import_simplexml</function></member>
+ </simplelist>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml?r1=1.15&r2=1.16&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml
diff -u phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml:1.15
phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml:1.16
--- phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml:1.15
Mon Jan 15 23:53:55 2007
+++ phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml Tue Jan
16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.15 $ -->
+<!-- $Revision: 1.16 $ -->
<refentry id='function.simplexml-load-file'>
<refnamediv>
<refname>simplexml_load_file</refname>
@@ -18,32 +18,82 @@
<methodparam
choice="opt"><type>bool</type><parameter>is_prefix</parameter></methodparam>
</methodsynopsis>
<para>
- This function will convert the well-formed XML document in the file
- specified by <parameter>filename</parameter> to an <type>object</type>
- of class <type>SimpleXMLElement</type>. If any errors occur during file
- access or interpretation, the function returns &false;.
+ Convert the well-formed XML document in the given file to an object.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- You may use the optional <parameter>class_name</parameter> parameter so
- that <function>simplexml_load_file</function> will return an object of
- the specified class. That class should extend the
- <type>SimpleXMLElement</type> class.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the XML file
+ </para>
+ <note>
+ <para>
+ Libxml 2 unescapes the URI, so if you want to pass e.g.
+ <literal>b&c</literal> as the URI parameter <literal>a</literal>,
+ you have to call
+ <literal>simplexml_load_file(rawurlencode('http://example.com/?a=' .
+ urlencode('b&c')))</literal>. Since PHP 5.1.0 you don't need to do
+ this because PHP will do it for you.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>class_name</parameter></term>
+ <listitem>
+ <para>
+ You may use this optional 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ns</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>is_prefix</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<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>.
+ Returns an <type>object</type> of class <type>SimpleXMLElement</type> with
+ properties containing the data held within the XML document. On errors, it
+ will return &false;.
</para>
- <note>
- <para>
- Libxml 2 unescapes the URI, so if you want to pass e.g.
- <literal>b&c</literal> as the URI parameter <literal>a</literal>,
- you have to call
- <literal>simplexml_load_file(rawurlencode('http://example.com/?a=' .
- urlencode('b&c')))</literal>. Since PHP 5.1.0 you don't need to do
- this because PHP will do it for you.
- </para>
- </note>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Interpret an XML document</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml?r1=1.12&r2=1.13&diff_format=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml
diff -u phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml:1.12
phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml:1.13
--- phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml:1.12
Mon Jan 15 23:53:55 2007
+++ phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml Tue Jan
16 01:05:32 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
<refentry id='function.simplexml-load-string'>
<refnamediv>
<refname>simplexml_load_string</refname>
@@ -18,22 +18,72 @@
<methodparam
choice="opt"><type>bool</type><parameter>is_prefix</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;.
+ Takes a well-formed XML string and returns it as an object.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<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.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ A well-formed XML string
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>class_name</parameter></term>
+ <listitem>
+ <para>
+ You may use this optional 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ns</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>is_prefix</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<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>.
+ Returns an <type>object</type> of class <type>SimpleXMLElement</type> with
+ properties containing the data held within the xml document. On errors, it
+ will return &false;.
</para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Interpret an XML string</title>
@@ -58,9 +108,7 @@
?>
]]>
</programlisting>
- <para>
- This script will display:
- </para>
+ &example.outputs;
<screen>
<