nlopess Wed Dec 8 08:14:43 2004 EDT
Modified files:
/phpdoc/en/reference/simplexml/functions simplexml-load-file.xml
simplexml-load-string.xml
Log:
document class_name and options
http://cvs.php.net/diff.php/phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml
diff -u phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml:1.7
phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml:1.8
--- phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml:1.7 Fri Nov
12 07:22:04 2004
+++ phpdoc/en/reference/simplexml/functions/simplexml-load-file.xml Wed Dec
8 08:14:42 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<refentry id='function.simplexml-load-file'>
<refnamediv>
<refname>simplexml_load_file</refname>
@@ -10,17 +10,28 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>SimpleXMLElement</type><methodname>simplexml_load_file</methodname>
+ <type>object</type><methodname>simplexml_load_file</methodname>
<methodparam><type>string</type><parameter>filename</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 convert the well-formed XML document in the file
specified by <parameter>filename</parameter> to an <type>object</type>
- of class <literal>SimpleXMLElement</literal>. If any errors occur
- during file access or interpretation, the function returns &false;.
+ of class <type>SimpleXMLElement</type>. If any errors occur during file
+ access or interpretation, the function returns &false;.
+ </para>
+ <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.
+ </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="simplexml.constants">additional Libxml parameters</link>.
</para>
- <!-- TODO: Document class_name and when it appeared. -->
<para>
<example>
<title>Interpret an XML document</title>
http://cvs.php.net/diff.php/phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml
diff -u phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml:1.7
phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml:1.8
--- phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml:1.7
Fri Nov 12 07:22:05 2004
+++ phpdoc/en/reference/simplexml/functions/simplexml-load-string.xml Wed Dec
8 08:14:42 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<refentry id='function.simplexml-load-string'>
<refnamediv>
<refname>simplexml_load_string</refname>
@@ -10,17 +10,28 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
-
<type>SimpleXMLElement</type><methodname>simplexml_load_string</methodname>
+ <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 object with properties
- containing the data held within the xml document. If any errors
- occur, it returns &false;.
+ <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="simplexml.constants">additional Libxml parameters</link>.
</para>
- <!-- TODO: Document class_name and when it appeared. -->
<para>
<example>
<title>Interpret an XML string</title>
