derick Fri Apr 19 07:11:22 2002 EDT
Modified files:
/phpdoc/en/reference/xml/functions utf8-decode.xml utf8-encode.xml
xml-error-string.xml
xml-get-current-byte-index.xml
xml-get-current-column-number.xml
xml-get-current-line-number.xml
xml-get-error-code.xml
xml-parse-into-struct.xml
xml-parse.xml
xml-parser-create-ns.xml
xml-parser-create.xml
xml-parser-free.xml
xml-parser-get-option.xml
xml-parser-set-option.xml
xml-set-character-data-handler.xml
xml-set-default-handler.xml
xml-set-element-handler.xml
xml-set-end-namespace-decl-handler.xml
xml-set-external-entity-ref-handler.xml
xml-set-notation-decl-handler.xml
xml-set-object.xml
xml-set-processing-instruction-handler.xml
xml-set-start-namespace-decl-handler.xml
xml-set-unparsed-entity-decl-handler.xml
Log:
- Fix return types, layout and parameter types
Index: phpdoc/en/reference/xml/functions/utf8-decode.xml
diff -u phpdoc/en/reference/xml/functions/utf8-decode.xml:1.2
phpdoc/en/reference/xml/functions/utf8-decode.xml:1.3
--- phpdoc/en/reference/xml/functions/utf8-decode.xml:1.2 Wed Apr 17 02:45:10
2002
+++ phpdoc/en/reference/xml/functions/utf8-decode.xml Fri Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.utf8-decode">
<refnamediv>
@@ -11,10 +11,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>utf8_decode</methodname>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>string</type><methodname>utf8_decode</methodname>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ </methodsynopsis>
<para>
This function decodes <parameter>data</parameter>, assumed to be
<literal>UTF-8</literal> encoded, to <literal>ISO-8859-1</literal>.
Index: phpdoc/en/reference/xml/functions/utf8-encode.xml
diff -u phpdoc/en/reference/xml/functions/utf8-encode.xml:1.2
phpdoc/en/reference/xml/functions/utf8-encode.xml:1.3
--- phpdoc/en/reference/xml/functions/utf8-encode.xml:1.2 Wed Apr 17 02:45:11
2002
+++ phpdoc/en/reference/xml/functions/utf8-encode.xml Fri Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.utf8-encode">
<refnamediv>
@@ -8,54 +8,52 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>utf8_encode</methodname>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>string</type><methodname>utf8_encode</methodname>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ </methodsynopsis>
<para>
This function encodes the string <parameter>data</parameter> to
<literal>UTF-8</literal>, and returns the encoded version.
<literal>UTF-8</literal> is a standard mechanism used by
<acronym>Unicode</acronym>for encoding <glossterm>wide
character</glossterm> values into a byte stream.
- <literal>UTF-8</literal> is transparent to plain
- <abbrev>ASCII</abbrev> characters, is self-synchronized (meaning
- it is possible for a program to figure out where in the
- bytestream characters start) and can be used with normal string
- comparison functions for sorting and such. PHP encodes
- <literal>UTF-8</literal> characters in up to four bytes, like
- this:
+ <literal>UTF-8</literal> is transparent to plain <abbrev>ASCII</abbrev>
+ characters, is self-synchronized (meaning it is possible for a program to
+ figure out where in the bytestream characters start) and can be used with
+ normal string comparison functions for sorting and such. PHP encodes
+ <literal>UTF-8</literal> characters in up to four bytes, like this:
<table>
<title>UTF-8 encoding</title>
<tgroup cols="3">
<thead>
- <row>
- <entry>bytes</entry>
- <entry>bits</entry>
- <entry>representation</entry>
- </row>
+ <row>
+ <entry>bytes</entry>
+ <entry>bits</entry>
+ <entry>representation</entry>
+ </row>
</thead>
<tbody>
- <row>
- <entry>1</entry>
- <entry>7</entry>
- <entry>0bbbbbbb</entry>
- </row>
- <row>
- <entry>2</entry>
- <entry>11</entry>
- <entry>110bbbbb 10bbbbbb</entry>
- </row>
- <row>
- <entry>3</entry>
- <entry>16</entry>
- <entry>1110bbbb 10bbbbbb 10bbbbbb</entry>
- </row>
- <row>
- <entry>4</entry>
- <entry>21</entry>
- <entry>11110bbb 10bbbbbb 10bbbbbb 10bbbbbb</entry>
- </row>
+ <row>
+ <entry>1</entry>
+ <entry>7</entry>
+ <entry>0bbbbbbb</entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>11</entry>
+ <entry>110bbbbb 10bbbbbb</entry>
+ </row>
+ <row>
+ <entry>3</entry>
+ <entry>16</entry>
+ <entry>1110bbbb 10bbbbbb 10bbbbbb</entry>
+ </row>
+ <row>
+ <entry>4</entry>
+ <entry>21</entry>
+ <entry>11110bbb 10bbbbbb 10bbbbbb 10bbbbbb</entry>
+ </row>
</tbody>
</tgroup>
</table>
Index: phpdoc/en/reference/xml/functions/xml-error-string.xml
diff -u phpdoc/en/reference/xml/functions/xml-error-string.xml:1.2
phpdoc/en/reference/xml/functions/xml-error-string.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-error-string.xml:1.2 Wed Apr 17 02:45:11
2002
+++ phpdoc/en/reference/xml/functions/xml-error-string.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-error-string">
<refnamediv>
@@ -8,18 +8,18 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>xml_error_string</methodname>
- <methodparam><type>int</type><parameter>code</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>string</type><methodname>xml_error_string</methodname>
+ <methodparam><type>int</type><parameter>code</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>code</parameter></term>
<listitem>
- <simpara>
- An error code from <function>xml_get_error_code</function>.
- </simpara>
+ <simpara>
+ An error code from <function>xml_get_error_code</function>.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.2
phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.2 Wed
Apr 17 02:45:11 2002
+++ phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml Fri Apr 19
+07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-get-current-byte-index">
<refnamediv>
@@ -8,18 +8,18 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_get_current_byte_index</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>xml_get_current_byte_index</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to get byte index from.
- </simpara>
+ <simpara>
+ A reference to the XML parser to get byte index from.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.2
phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.2 Wed
Apr 17 02:45:12 2002
+++ phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml Fri Apr 19
+07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-get-current-column-number">
<refnamediv>
@@ -10,18 +10,18 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_get_current_column_number</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>xml_get_current_column_number</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to get column number from.
- </simpara>
+ <simpara>
+ A reference to the XML parser to get column number from.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.2
phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.2 Wed
Apr 17 02:45:12 2002
+++ phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml Fri Apr 19
+07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-get-current-line-number">
<refnamediv>
@@ -8,18 +8,18 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_get_current_line_number</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>xml_get_current_line_number</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to get line number from.
- </simpara>
+ <simpara>
+ A reference to the XML parser to get line number from.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-get-error-code.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.2
phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.2 Wed Apr 17
02:45:12 2002
+++ phpdoc/en/reference/xml/functions/xml-get-error-code.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-get-error-code">
<refnamediv>
@@ -8,18 +8,18 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_get_error_code</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>xml_get_error_code</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to get error code from.
- </simpara>
+ <simpara>
+ A reference to the XML parser to get error code from.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml
diff -u phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml:1.2
phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml:1.2 Wed Apr 17
02:45:12 2002
+++ phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.11 -->
<refentry id="function.xml-parse-into-struct">
<refnamediv>
@@ -8,13 +8,13 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_parse_into_struct</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam><type>array</type><parameter>&values</parameter></methodparam>
- <methodparam><type>array</type><parameter>&index</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>xml_parse_into_struct</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodparam><type>array</type><parameter>&values</parameter></methodparam>
+ <methodparam><type>array</type><parameter>&index</parameter></methodparam>
+ </methodsynopsis>
<para>
This function parses an XML file into 2 parallel array
structures, one (<parameter>index</parameter>) containing pointers
@@ -125,9 +125,9 @@
]]>
</programlisting>
</example>
- And some code to parse the document and generate the appropriate
- objects:
- <example>
+ And some code to parse the document and generate the appropriate
+ objects:
+ <example>
<title>
parsemoldb.php - parses moldb.xml into and array of
molecular objects
@@ -188,13 +188,13 @@
?>
]]>
</programlisting>
- </example>
- After executing <filename>parsemoldb.php</filename>, the variable
- <varname>$db</varname> contains an array of
- <classname>AminoAcid</classname> objects, and the output of the
- script confirms that:
- <informalexample>
- <screen>
+ </example>
+ After executing <filename>parsemoldb.php</filename>, the variable
+ <varname>$db</varname> contains an array of
+ <classname>AminoAcid</classname> objects, and the output of the
+ script confirms that:
+ <informalexample>
+ <screen>
<![CDATA[
** Database of AminoAcid objects:
Array
@@ -217,8 +217,8 @@
)
]]>
- </screen>
- </informalexample>
+ </screen>
+ </informalexample>
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/xml/functions/xml-parse.xml
diff -u phpdoc/en/reference/xml/functions/xml-parse.xml:1.2
phpdoc/en/reference/xml/functions/xml-parse.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parse.xml:1.2 Wed Apr 17 02:45:13 2002
+++ phpdoc/en/reference/xml/functions/xml-parse.xml Fri Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-parse">
<refnamediv>
@@ -8,40 +8,40 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_parse</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>isFinal</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_parse</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodparam
+choice="opt"><type>bool</type><parameter>is_final</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to use.
- </simpara>
+ <simpara>
+ A reference to the XML parser to use.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
- <simpara>
- Chunk of data to parse. A document may be parsed piece-wise
- by calling <function>xml_parse</function> several times with
- new data, as long as the <parameter>isFinal</parameter>
- parameter is set and &true; when the last data is parsed.
- </simpara>
+ <simpara>
+ Chunk of data to parse. A document may be parsed piece-wise by
+ calling <function>xml_parse</function> several times with new data,
+ as long as the <parameter>is_final</parameter> parameter is set and
+ &true; when the last data is parsed.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>isFinal</parameter> (optional)</term>
+ <term><parameter>is_final</parameter> (optional)</term>
<listitem>
- <simpara>
- If set and &true;, <parameter>data</parameter> is the last
- piece of data sent in this parse.
- </simpara>
+ <simpara>
+ If set and &true;, <parameter>data</parameter> is the last piece of
+ data sent in this parse.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml
diff -u phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml:1.2
phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml:1.2 Wed Apr 17
02:45:13 2002
+++ phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 -->
<refentry id='function.xml-parser-create-ns'>
<refnamediv>
@@ -10,11 +10,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_parser_create_ns</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>sep</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>xml_parser_create_ns</methodname>
+ <methodparam
+choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+ <methodparam
+choice="opt"><type>string</type><parameter>sep</parameter></methodparam>
+ </methodsynopsis>
<para>
&warn.undocumented.func;
</para>
Index: phpdoc/en/reference/xml/functions/xml-parser-create.xml
diff -u phpdoc/en/reference/xml/functions/xml-parser-create.xml:1.2
phpdoc/en/reference/xml/functions/xml-parser-create.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parser-create.xml:1.2 Wed Apr 17 02:45:13
2002
+++ phpdoc/en/reference/xml/functions/xml-parser-create.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-parser-create">
<refnamediv>
@@ -8,30 +8,29 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_parser_create</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>xml_parser_create</methodname>
+ <methodparam
+choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter> (optional)</term>
<listitem>
- <para>
- Which character encoding the parser should use. The
- following character encodings are supported:
- <simplelist>
- <member><literal>ISO-8859-1</literal> (default)</member>
- <member><literal>US-ASCII</literal></member>
- <member><literal>UTF-8</literal></member>
- </simplelist>
- </para>
+ <para>
+ Which character encoding the parser should use. The following
+ character encodings are supported:
+ <simplelist>
+ <member><literal>ISO-8859-1</literal> (default)</member>
+ <member><literal>US-ASCII</literal></member>
+ <member><literal>UTF-8</literal></member>
+ </simplelist>
+ </para>
</listitem>
</varlistentry>
</variablelist>
- This function creates an XML parser and returns a handle for use
- by other XML functions. Returns &false; on
- failure.
+ This function creates an XML parser and returns a handle for use by other
+ XML functions. Returns &false; on failure.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/xml/functions/xml-parser-free.xml
diff -u phpdoc/en/reference/xml/functions/xml-parser-free.xml:1.2
phpdoc/en/reference/xml/functions/xml-parser-free.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parser-free.xml:1.2 Wed Apr 17 02:45:13
2002
+++ phpdoc/en/reference/xml/functions/xml-parser-free.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-parser-free">
<refnamediv>
@@ -8,25 +8,24 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>xml_parser_free</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_parser_free</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to free.
- </simpara>
+ <simpara>
+ A reference to the XML parser to free.
+ </simpara>
</listitem>
</varlistentry>
</variablelist></para>
<para>
- This function returns &false; if <parameter>parser</parameter> does
- not refer to a valid parser, or else it frees the parser and
- returns &true;.
+ This function returns &false; if <parameter>parser</parameter> does not
+ refer to a valid parser, or else it frees the parser and returns &true;.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/xml/functions/xml-parser-get-option.xml
diff -u phpdoc/en/reference/xml/functions/xml-parser-get-option.xml:1.2
phpdoc/en/reference/xml/functions/xml-parser-get-option.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parser-get-option.xml:1.2 Wed Apr 17
02:45:13 2002
+++ phpdoc/en/reference/xml/functions/xml-parser-get-option.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-parser-get-option">
<refnamediv>
@@ -8,30 +8,28 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>mixed</type><methodname>xml_parser_get_option</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>int</type><parameter>option</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>mixed</type><methodname>xml_parser_get_option</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>int</type><parameter>option</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to get an option
- from.
- </simpara>
+ <simpara>
+ A reference to the XML parser to get an option from.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
- <simpara>
- Which option to fetch. See
- <function>xml_parser_set_option</function> for a list of
- options.
- </simpara>
+ <simpara>
+ Which option to fetch. See
+ <function>xml_parser_set_option</function> for a list of options.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
Index: phpdoc/en/reference/xml/functions/xml-parser-set-option.xml
diff -u phpdoc/en/reference/xml/functions/xml-parser-set-option.xml:1.2
phpdoc/en/reference/xml/functions/xml-parser-set-option.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-parser-set-option.xml:1.2 Wed Apr 17
02:45:14 2002
+++ phpdoc/en/reference/xml/functions/xml-parser-set-option.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-parser-set-option">
<refnamediv>
@@ -8,44 +8,44 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_parser_set_option</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>int</type><parameter>option</parameter></methodparam>
- <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_parser_set_option</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>int</type><parameter>option</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
+ </methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- A reference to the XML parser to set an option in.
- </simpara>
+ <simpara>
+ A reference to the XML parser to set an option in.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
- <simpara>
- Which option to set. See below.
- </simpara>
+ <simpara>
+ Which option to set. See below.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
- <simpara>
- The option's new value.
- </simpara>
+ <simpara>
+ The option's new value.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
- This function returns &false; if <parameter>parser</parameter> does
- not refer to a valid parser, or if the option could not be set.
- Else the option is set and &true; is returned.
+ This function returns &false; if <parameter>parser</parameter> does not
+ refer to a valid parser, or if the option could not be set. Else the
+ option is set and &true; is returned.
</para>
<para>
The following options are available:
@@ -53,34 +53,33 @@
<title>XML parser options</title>
<tgroup cols="3">
<thead>
- <row>
- <entry>Option constant</entry>
- <entry>Data type</entry>
- <entry>Description</entry>
- </row>
+ <row>
+ <entry>Option constant</entry>
+ <entry>Data type</entry>
+ <entry>Description</entry>
+ </row>
</thead>
<tbody>
- <row>
- <entry>XML_OPTION_CASE_FOLDING</entry>
- <entry>integer</entry>
- <entry>
- Controls whether <link
- linkend="xml.case-folding">case-folding</link> is enabled
- for this XML parser. Enabled by default.
- </entry>
- </row>
- <row>
- <entry>XML_OPTION_TARGET_ENCODING</entry>
- <entry>string</entry>
- <entry>
- Sets which <link linkend="xml.encoding">target
- encoding</link> to use in this XML parser. By default, it
- is set to the same as the source encoding used by
- <function>xml_parser_create</function>. Supported target
- encodings are <literal>ISO-8859-1</literal>,
- <literal>US-ASCII</literal> and <literal>UTF-8</literal>.
- </entry>
- </row>
+ <row>
+ <entry>XML_OPTION_CASE_FOLDING</entry>
+ <entry>integer</entry>
+ <entry>
+ Controls whether <link
+ linkend="xml.case-folding">case-folding</link> is enabled for this
+ XML parser. Enabled by default.
+ </entry>
+ </row>
+ <row>
+ <entry>XML_OPTION_TARGET_ENCODING</entry>
+ <entry>string</entry>
+ <entry>
+ Sets which <link linkend="xml.encoding">target encoding</link> to
+ use in this XML parser. By default, it is set to the same as the
+ source encoding used by <function>xml_parser_create</function>.
+ Supported target encodings are <literal>ISO-8859-1</literal>,
+ <literal>US-ASCII</literal> and <literal>UTF-8</literal>.
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
Index: phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml:1.2 Wed
Apr 17 02:45:14 2002
+++ phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml Fri
+Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-character-data-handler">
<refnamediv>
@@ -8,49 +8,49 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_character_data_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>handler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_character_data_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>handler</parameter></methodparam>
+ </methodsynopsis>
<para>
Sets the character data handler function for the XML parser
- <parameter>parser</parameter>. <parameter>handler</parameter> is
- a string containing the name of a function that must exist when
+ <parameter>parser</parameter>. <parameter>handler</parameter> is a
+ string containing the name of a function that must exist when
<function>xml_parse</function> is called for
- <parameter>parser</parameter>.</para>
+ <parameter>parser</parameter>.
+ </para>
<para>
The function named by <parameter>handler</parameter> must accept
two parameters:
<methodsynopsis>
- <methodname><replaceable>handler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodname><replaceable>handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
- <simpara>
- The second parameter, <parameter>data</parameter>, contains
- the character data as a string.
- </simpara>
+ <simpara>
+ The second parameter, <parameter>data</parameter>, contains
+ the character data as a string.
+ </simpara>
</listitem>
</varlistentry>
</variablelist></para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is
- disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handler is set up, &false; if
Index: phpdoc/en/reference/xml/functions/xml-set-default-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-default-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-default-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-default-handler.xml:1.2 Wed Apr 17
02:45:14 2002
+++ phpdoc/en/reference/xml/functions/xml-set-default-handler.xml Fri Apr 19
+07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-default-handler">
<refnamediv>
@@ -8,56 +8,56 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_default_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>handler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_default_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>handler</parameter></methodparam>
+ </methodsynopsis>
<para>
Sets the default handler function for the XML parser
- <parameter>parser</parameter>. <parameter>handler</parameter> is
- a string containing the name of a function that must exist when
+ <parameter>parser</parameter>. <parameter>handler</parameter> is a
+ string containing the name of a function that must exist when
<function>xml_parse</function> is called for
- <parameter>parser</parameter>.</para>
+ <parameter>parser</parameter>.
+ </para>
<para>
The function named by <parameter>handler</parameter> must accept
two parameters:
<methodsynopsis>
- <methodname><replaceable>handler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodname><replaceable>handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term>
- <parameter>parser</parameter>
+ <parameter>parser</parameter>
</term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the
- handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <parameter>data</parameter>
+ <parameter>data</parameter>
</term>
<listitem>
- <simpara>
- The second parameter, <parameter>data</parameter>, contains
- the character data. This may be the XML declaration,
- document type declaration, entities or other data for which
- no other handler exists.
- </simpara>
+ <simpara>
+ The second parameter, <parameter>data</parameter>, contains
+ the character data. This may be the XML declaration,
+ document type declaration, entities or other data for which
+ no other handler exists.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handler is set up, &false; if
Index: phpdoc/en/reference/xml/functions/xml-set-element-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-element-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-element-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-element-handler.xml:1.2 Wed Apr 17
02:45:14 2002
+++ phpdoc/en/reference/xml/functions/xml-set-element-handler.xml Fri Apr 19
+07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-element-handler">
<refnamediv>
@@ -8,111 +8,107 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_element_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
-
<methodparam><type>string</type><parameter>startElementHandler</parameter></methodparam>
-
<methodparam><type>string</type><parameter>endElementHandler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_element_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+
+<methodparam><type>string</type><parameter>start_element_handler</parameter></methodparam>
+
+<methodparam><type>string</type><parameter>end_element_handler</parameter></methodparam>
+ </methodsynopsis>
<para>
Sets the element handler functions for the XML parser
<parameter>parser</parameter>.
- <parameter>startElementHandler</parameter> and
- <parameter>endElementHandler</parameter> are strings containing
+ <parameter>start_element_handler</parameter> and
+ <parameter>end_element_handler</parameter> are strings containing
the names of functions that must exist when
<function>xml_parse</function> is called for
<parameter>parser</parameter>.
</para>
<para>
- The function named by <parameter>startElementHandler</parameter>
+ The function named by <parameter>start_element_handler</parameter>
must accept three parameters:
<methodsynopsis>
- <methodname><replaceable>startElementHandler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- <methodparam><type>array</type><parameter>attribs</parameter></methodparam>
+ <methodname><replaceable>start_element_handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ <methodparam><type>array</type><parameter>attribs</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the
- handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
- <simpara>
- The second parameter, <parameter>name</parameter>, contains
- the name of the element for which this handler is called. If
- <link linkend="xml.case-folding">case-folding</link> is in
- effect for this parser, the element name will be in uppercase
- letters.
- </simpara>
+ <simpara>
+ The second parameter, <parameter>name</parameter>, contains the name
+ of the element for which this handler is called. If <link
+ linkend="xml.case-folding">case-folding</link> is in effect for this
+ parser, the element name will be in uppercase letters.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attribs</parameter></term>
<listitem>
- <simpara>
- The third parameter, <parameter>attribs</parameter>, contains
- an associative array with the element's attributes (if any).
- The keys of this array are the attribute names, the values
- are the attribute values. Attribute names are <link
- linkend="xml.case-folding">case-folded</link> on the same
- criteria as element names. Attribute values are
- <emphasis>not</emphasis> case-folded.
- </simpara>
- <simpara>
- The original order of the attributes can be retrieved by
- walking through <parameter>attribs</parameter> the normal
- way, using <function>each</function>. The first key in the
- array was the first attribute, and so on.
- </simpara>
+ <simpara>
+ The third parameter, <parameter>attribs</parameter>, contains an
+ associative array with the element's attributes (if any). The keys
+ of this array are the attribute names, the values are the attribute
+ values. Attribute names are <link
+ linkend="xml.case-folding">case-folded</link> on the same criteria as
+ element names. Attribute values are <emphasis>not</emphasis>
+ case-folded.
+ </simpara>
+ <simpara>
+ The original order of the attributes can be retrieved by walking
+ through <parameter>attribs</parameter> the normal way, using
+ <function>each</function>. The first key in the array was the first
+ attribute, and so on.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
- The function named by <parameter>endElementHandler</parameter>
+ The function named by <parameter>end_element_handler</parameter>
must accept two parameters:
<methodsynopsis>
- <methodname><replaceable>endElementHandler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
+ <methodname><replaceable>end_element_handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the
- handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
- <simpara>
- The second parameter, <parameter>name</parameter>, contains
- the name of the element for which this handler is called. If
- <link linkend="xml.case-folding">case-folding</link> is in
- effect for this parser, the element name will be in uppercase
- letters.
- </simpara>
+ <simpara>
+ The second parameter, <parameter>name</parameter>, contains the name
+ of the element for which this handler is called. If <link
+ linkend="xml.case-folding">case-folding</link> is in effect for this
+ parser, the element name will be in uppercase letters.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handlers are set up, &false; if
Index: phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.2
Wed Apr 17 02:45:14 2002
+++ phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml Fri
+Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 -->
<refentry id='function.xml-set-end-namespace-decl-handler'>
<refnamediv>
@@ -10,11 +10,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_end_namespace_decl_handler</methodname>
- <methodparam><type>int</type><parameter>pind</parameter></methodparam>
- <methodparam><type>string</type><parameter>hdl</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_end_namespace_decl_handler</methodname>
+ <methodparam><type>resource</type><parameter>pind</parameter></methodparam>
+ <methodparam><type>string</type><parameter>hdl</parameter></methodparam>
+ </methodsynopsis>
<para>
&warn.undocumented.func;
</para>
Index: phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml:1.2
Wed Apr 17 02:45:15 2002
+++ phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml Fri
+Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-external-entity-ref-handler">
<refnamediv>
@@ -8,11 +8,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_external_entity_ref_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>handler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_external_entity_ref_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>handler</parameter></methodparam>
+ </methodsynopsis>
<para>
Sets the notation declaration handler function for the XML parser
<parameter>parser</parameter>. <parameter>handler</parameter> is
@@ -28,72 +28,70 @@
<function>xml_get_error_code</function> will return <systemitem
class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>.
<methodsynopsis>
- <type>int</type><methodname><replaceable>handler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
-
<methodparam><type>string</type><parameter>openEntityNames</parameter></methodparam>
- <methodparam><type>string</type><parameter>base</parameter></methodparam>
- <methodparam><type>string</type><parameter>systemId</parameter></methodparam>
- <methodparam><type>string</type><parameter>publicId</parameter></methodparam>
+ <methodname><replaceable>handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+
+<methodparam><type>string</type><parameter>open_entity_names</parameter></methodparam>
+ <methodparam><type>string</type><parameter>base</parameter></methodparam>
+ <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>public_id</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>openEntityNames</parameter></term>
+ <term><parameter>open_entity_names</parameter></term>
<listitem>
- <simpara>
- The second parameter, <parameter>openEntityNames</parameter>,
- is a space-separated list of the names of the entities that
- are open for the parse of this entity (including the name of
- the referenced entity).
- </simpara>
+ <simpara>
+ The second parameter, <parameter>open_entity_names</parameter>, is a
+ space-separated list of the names of the entities that are open for
+ the parse of this entity (including the name of the referenced
+ entity).
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>base</parameter></term>
<listitem>
- <simpara>
- This is the base for resolving the system identifier
- (<parameter>systemid</parameter>) of the external entity.
- Currently this parameter will always be set to an empty
- string.
- </simpara>
+ <simpara>
+ This is the base for resolving the system identifier
+ (<parameter>systemid</parameter>) of the external entity. Currently
+ this parameter will always be set to an empty string.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>systemId</parameter></term>
+ <term><parameter>system_id</parameter></term>
<listitem>
- <simpara>
- The fourth parameter, <parameter>systemId</parameter>, is the
- system identifier as specified in the entity declaration.
- </simpara>
+ <simpara>
+ The fourth parameter, <parameter>system_id</parameter>, is the
+ system identifier as specified in the entity declaration.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>publicId</parameter></term>
+ <term><parameter>public_id</parameter></term>
<listitem>
- <simpara>
- The fifth parameter, <parameter>publicId</parameter>, is the
- public identifier as specified in the entity declaration, or
- an empty string if none was specified; the whitespace in the
- public identifier will have been normalized as required by
- the XML spec.
- </simpara>
+ <simpara>
+ The fifth parameter, <parameter>public_id</parameter>, is the
+ public identifier as specified in the entity declaration, or
+ an empty string if none was specified; the whitespace in the
+ public identifier will have been normalized as required by
+ the XML spec.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is
- disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handler is set up, &false; if
Index: phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml:1.2 Wed
Apr 17 02:45:15 2002
+++ phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml Fri Apr 19
+07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-notation-decl-handler">
<refnamediv>
@@ -8,11 +8,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_notation_decl_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>handler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_notation_decl_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>handler</parameter></methodparam>
+ </methodsynopsis>
<para>
Sets the notation declaration handler function for the XML parser
<parameter>parser</parameter>. <parameter>handler</parameter> is
@@ -23,8 +23,8 @@
<para>
A notation declaration is part of the document's DTD and has the
following format: <programlisting role="xml"><!NOTATION
- <parameter>name</parameter> {<parameter>systemId</parameter> |
- <parameter>publicId</parameter>}></programlisting> See <ulink
+ <parameter>name</parameter> {<parameter>system_id</parameter> |
+ <parameter>public_id</parameter>}></programlisting> See <ulink
url="&url.rec-xml;#Notations">section 4.7 of the XML 1.0
spec</ulink> for the definition of notation declarations.
</para>
@@ -32,74 +32,69 @@
The function named by <parameter>handler</parameter> must accept
five parameters:
<methodsynopsis>
- <methodname><replaceable>handler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
-
<methodparam><type>string</type><parameter>notationName</parameter></methodparam>
- <methodparam><type>string</type><parameter>base</parameter></methodparam>
- <methodparam><type>string</type><parameter>systemId</parameter></methodparam>
- <methodparam><type>string</type><parameter>publicId</parameter></methodparam>
+ <methodname><replaceable>handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+
+<methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
+ <methodparam><type>string</type><parameter>base</parameter></methodparam>
+ <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>public_id</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term>
- <parameter>parser</parameter>
+ <parameter>parser</parameter>
</term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the
- handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>notationName</parameter></term>
+ <term><parameter>notation_name</parameter></term>
<listitem>
- <simpara>
- This is the notation's <parameter>name</parameter>, as per
- the notation format described above.
- </simpara>
+ <simpara>
+ This is the notation's <parameter>name</parameter>, as per
+ the notation format described above.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <parameter>base</parameter>
+ <parameter>base</parameter>
</term>
<listitem>
- <simpara>
- This is the base for resolving the system identifier
- (<parameter>systemId</parameter>) of the notation
- declaration. Currently this parameter will always be set to
- an empty string.
- </simpara>
+ <simpara>
+ This is the base for resolving the system identifier
+ (<parameter>system_id</parameter>) of the notation declaration.
+ Currently this parameter will always be set to an empty string.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>systemId</parameter></term>
+ <term><parameter>system_id</parameter></term>
<listitem>
- <simpara>
- System identifier of the external notation
- declaration.
- </simpara>
+ <simpara>
+ System identifier of the external notation declaration.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <parameter>publicId</parameter>
+ <parameter>public_id</parameter>
</term>
<listitem>
- <simpara>
- Public identifier of the external notation
- declaration.
- </simpara>
+ <simpara>
+ Public identifier of the external notation declaration.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is
- disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handler is set up, &false; if
Index: phpdoc/en/reference/xml/functions/xml-set-object.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-object.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-object.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-object.xml:1.2 Wed Apr 17 02:45:15
2002
+++ phpdoc/en/reference/xml/functions/xml-set-object.xml Fri Apr 19 07:11:21
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-object">
<refnamediv>
@@ -8,50 +8,56 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>xml_set_object</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>object</type><parameter>&object</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>void</type><methodname>xml_set_object</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>object</type><parameter>&object</parameter></methodparam>
+ </methodsynopsis>
<para>
This function allows to use <parameter>parser</parameter> inside
- <parameter>object</parameter>. All callback functions could be
- set with <function>xml_set_element_handler</function> etc and
- assumed to be methods of <parameter>object</parameter>.
+ <parameter>object</parameter>. All callback functions could be set with
+ <function>xml_set_element_handler</function> etc and assumed to be
+ methods of <parameter>object</parameter>.
</para>
<programlisting role="php">
<![CDATA[
<?php
class xml {
-var $parser;
+ var $parser;
-function xml() {
- $this->parser = xml_parser_create();
- xml_set_object($this->parser,&$this);
- xml_set_element_handler($this->parser,"tag_open","tag_close");
- xml_set_character_data_handler($this->parser,"cdata");
-}
-
-function parse($data) {
- xml_parse($this->parser,$data);
-}
-
-function tag_open($parser,$tag,$attributes) {
- var_dump($parser,$tag,$attributes);
-}
-
-function cdata($parser,$cdata) {
- var_dump($parser,$cdata);
-}
-
-function tag_close($parser,$tag) {
- var_dump($parser,$tag);
-}
+ function xml()
+ {
+ $this->parser = xml_parser_create();
+
+ xml_set_object($this->parser, &$this);
+ xml_set_element_handler($this->parser, "tag_open", "tag_close");
+ xml_set_character_data_handler($this->parser, "cdata");
+ }
+
+ function parse($data)
+ {
+ xml_parse($this->parser, $data);
+ }
+
+ function tag_open($parser, $tag, $attributes)
+ {
+ var_dump($parser, $tag, $attributes);
+ }
+
+ function cdata($parser, $cdata)
+ {
+ var_dump($parser, $cdata);
+ }
+
+ function tag_close($parser, $tag)
+ {
+ var_dump($parser, $tag);
+ }
} // end of class xml
$xml_parser = new xml();
-$xml_parser->parse("<A ID=\"hallo\">PHP</A>");
+$xml_parser->parse("<A ID='hallo'>PHP</A>");
?>
]]>
</programlisting>
Index: phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml
diff -u
phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml:1.2
Wed Apr 17 02:45:15 2002
+++ phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml
+ Fri Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-processing-instruction-handler">
<refnamediv>
@@ -10,17 +10,17 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_processing_instruction_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>handler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_processing_instruction_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>handler</parameter></methodparam>
+ </methodsynopsis>
<para>
- Sets the processing instruction (PI) handler function for the XML
- parser <parameter>parser</parameter>.
- <parameter>handler</parameter> is a string containing the name of
- a function that must exist when <function>xml_parse</function> is
- called for <parameter>parser</parameter>.
+ Sets the processing instruction (PI) handler function for the XML parser
+ <parameter>parser</parameter>. <parameter>handler</parameter> is a
+ string containing the name of a function that must exist when
+ <function>xml_parse</function> is called for
+ <parameter>parser</parameter>.
</para>
<para>
A processing instruction has the following format:
@@ -30,45 +30,54 @@
<replaceable>data</replaceable>?>
</programlisting>
</informalexample>
- You can put PHP code into such a tag, but be aware of one
- limitation: in an XML PI, the PI end tag
- (<literal>?></literal>) can not be quoted, so this character
- sequence should not appear in the PHP code you embed with PIs in
- XML documents. If it does, the rest of the PHP code, as well as
- the "real" PI end tag, will be treated as character data.
+ You can put PHP code into such a tag, but be aware of one limitation: in
+ an XML PI, the PI end tag (<literal>?></literal>) can not be quoted,
+ so this character sequence should not appear in the PHP code you embed
+ with PIs in XML documents. If it does, the rest of the PHP code, as well
+ as the "real" PI end tag, will be treated as character data.
</para>
<para>
The function named by <parameter>handler</parameter> must accept
three parameters:
<methodsynopsis>
- <methodname><replaceable>handler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>target</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodname><replaceable>handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>target</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
- <term><parameter>parser</parameter></term> <listitem><simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the
- handler.</simpara></listitem>
+ <term><parameter>parser</parameter></term>
+ <listitem>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the handler.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
- <listitem><simpara>
- The second parameter, <parameter>target</parameter>, contains
- the PI target.</simpara></listitem>
+ <listitem>
+ <simpara>
+ The second parameter, <parameter>target</parameter>, contains the PI
+ target.
+ </simpara>
+ </listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
- <listitem><simpara>
- The third parameter, <parameter>data</parameter>, contains
- the PI data.</simpara></listitem>
+ <listitem>
+ <simpara>
+ The third parameter, <parameter>data</parameter>, contains the PI
+ data.
+ </simpara>
+ </listitem>
</varlistentry>
- </variablelist></para>
+ </variablelist>
+ </para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handler is set up, &false; if
Index: phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.2
Wed Apr 17 02:45:15 2002
+++ phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml Fri
+Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 -->
<refentry id='function.xml-set-start-namespace-decl-handler'>
<refnamediv>
@@ -10,11 +10,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_start_namespace_decl_handler</methodname>
- <methodparam><type>int</type><parameter>pind</parameter></methodparam>
- <methodparam><type>string</type><parameter>hdl</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname>
+ <methodparam><type>resource</type><parameter>pind</parameter></methodparam>
+ <methodparam><type>string</type><parameter>hdl</parameter></methodparam>
+ </methodsynopsis>
<para>
&warn.undocumented.func;
</para>
Index: phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml
diff -u phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml:1.2
phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml:1.3
--- phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml:1.2
Wed Apr 17 02:45:15 2002
+++ phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml Fri
+Apr 19 07:11:21 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-set-unparsed-entity-decl-handler">
<refnamediv>
@@ -10,17 +10,18 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>handler</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>handler</parameter></methodparam>
+ </methodsynopsis>
<para>
- Sets the unparsed entity declaration handler function for the XML
- parser <parameter>parser</parameter>.
- <parameter>handler</parameter> is a string containing the name of
- a function that must exist when <function>xml_parse</function> is
- called for <parameter>parser</parameter>.</para>
+ Sets the unparsed entity declaration handler function for the XML parser
+ <parameter>parser</parameter>. <parameter>handler</parameter> is a
+ string containing the name of a function that must exist when
+ <function>xml_parse</function> is called for
+ <parameter>parser</parameter>.
+ </para>
<para>
This handler will be called if the XML parser encounters an
external entity declaration with an NDATA declaration, like the
@@ -35,75 +36,76 @@
the XML 1.0 spec</ulink> for the definition of notation declared
external entities.
</para>
- <para> The function named by
- <parameter>handler</parameter> must accept six parameters:
+ <para>
+ The function named by <parameter>handler</parameter> must accept six
+ parameters:
<methodsynopsis>
- <methodname><replaceable>handler</replaceable></methodname>
- <methodparam><type>int</type><parameter>parser</parameter></methodparam>
- <methodparam><type>string</type><parameter>entityName</parameter></methodparam>
- <methodparam><type>string</type><parameter>base</parameter></methodparam>
- <methodparam><type>string</type><parameter>systemId</parameter></methodparam>
- <methodparam><type>string</type><parameter>publicId</parameter></methodparam>
-
<methodparam><type>string</type><parameter>notationName</parameter></methodparam>
+ <methodname><replaceable>handler</replaceable></methodname>
+ <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
+ <methodparam><type>string</type><parameter>entity_name</parameter></methodparam>
+ <methodparam><type>string</type><parameter>base</parameter></methodparam>
+ <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>public_id</parameter></methodparam>
+
+<methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
- The first parameter, <replaceable>parser</replaceable>, is a
- reference to the XML parser calling the
- handler.
- </simpara>
+ <simpara>
+ The first parameter, <replaceable>parser</replaceable>, is a
+ reference to the XML parser calling the
+ handler.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>entityName</parameter></term>
+ <term><parameter>entity_name</parameter></term>
<listitem>
- <simpara>
- The name of the entity that is about to be defined.
- </simpara>
+ <simpara>
+ The name of the entity that is about to be defined.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>base</parameter></term>
- <listitem><simpara>
- This is the base for resolving the system identifier
- (<parameter>systemId</parameter>) of the external
- entity. Currently this parameter will always be set to
- an empty string.
- </simpara>
+ <listitem>
+ <simpara>
+ This is the base for resolving the system identifier
+ (<parameter>systemId</parameter>) of the external entity. Currently
+ this parameter will always be set to an empty string.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>systemId</parameter></term>
+ <term><parameter>system_id</parameter></term>
<listitem>
- <simpara>
- System identifier for the external entity.
- </simpara>
+ <simpara>
+ System identifier for the external entity.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>publicId</parameter></term>
+ <term><parameter>public_id</parameter></term>
<listitem>
- <simpara>
- Public identifier for the external entity.
- </simpara>
+ <simpara>
+ Public identifier for the external entity.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>notationName</parameter></term>
+ <term><parameter>notation_name</parameter></term>
<listitem>
- <simpara>
- Name of the notation of this entity (see
- <function>xml_set_notation_decl_handler</function>).
- </simpara>
+ <simpara>
+ Name of the notation of this entity (see
+ <function>xml_set_notation_decl_handler</function>).
+ </simpara>
</listitem>
</varlistentry>
</variablelist></para>
<para>
- If a handler function is set to an empty string, or
- &false;, the handler in question is disabled.
+ If a handler function is set to an empty string, or &false;, the handler
+ in question is disabled.
</para>
<para>
&true; is returned if the handler is set up, &false; if
