sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ref.xml: new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237702 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-06-15 00:10:03 +00:00
parent f437acec06
commit 57cd821db5
24 changed files with 1022 additions and 572 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
reference/xml/functions/utf8-decode.xml
View file

@ -1,15 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.utf8-decode">
<refnamediv>
<refname>utf8_decode</refname>
<refpurpose>
Converts a string with ISO-8859-1 characters encoded with UTF-8
to single-byte ISO-8859-1
</refpurpose>
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>utf8_decode</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
@ -18,12 +19,40 @@
This function decodes <parameter>data</parameter>, assumed to be
<literal>UTF-8</literal> encoded, to <literal>ISO-8859-1</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>utf8_encode</function> for an explanation of UTF-8
encoding.
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
An UTF-8 encoded string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the ISO-8859-1 translation of <parameter>data</parameter>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>utf8_encode</function> for an explanation of UTF-8 encoding</member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/xml/functions/utf8-encode.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.utf8-encode">
<refnamediv>
<refname>utf8_encode</refname>
<refpurpose>Encodes an ISO-8859-1 string to UTF-8</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>utf8_encode</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
@ -60,6 +61,30 @@
used to store character data.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
An ISO-8859-1 string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the UTF-8 translation of <parameter>data</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/xml/functions/xml-error-string.xml
View file

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.xml-error-string">
<refnamediv>
<refname>xml_error_string</refname>
<refpurpose>Get XML parser error string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -16,6 +17,7 @@
<parameter>code</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -31,6 +33,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -38,6 +41,7 @@
<parameter>code</parameter>, or &false; if no description was found.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -46,6 +50,7 @@
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/xml/functions/xml-get-current-byte-index.xml
View file

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.xml-get-current-byte-index">
<refnamediv>
<refname>xml_get_current_byte_index</refname>
<refpurpose>Get current byte index for an XML parser</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -15,6 +16,7 @@
Gets the current byte index of the given XML parser.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -30,6 +32,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -38,6 +41,7 @@
the parser is currently at in its data buffer (starting at 0).
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
@ -47,6 +51,7 @@
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -56,6 +61,7 @@
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/xml/functions/xml-get-current-column-number.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.xml-get-current-column-number">
<refnamediv>
<refname>xml_get_current_column_number</refname>
@ -7,6 +7,7 @@
Get current column number for an XML parser
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -17,6 +18,7 @@
Gets the current column number of the given XML parser.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -32,6 +34,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -42,6 +45,7 @@
currently at.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -51,6 +55,7 @@
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/xml/functions/xml-get-current-line-number.xml
View file

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.xml-get-current-line-number">
<refnamediv>
<refname>xml_get_current_line_number</refname>
<refpurpose>Get current line number for an XML parser</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -15,6 +16,7 @@
Gets the current line number for the given XML parser.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -30,6 +32,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -38,6 +41,7 @@
parser is currently at in its data buffer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -47,6 +51,7 @@
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/xml/functions/xml-get-error-code.xml
View file

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.xml-get-error-code">
<refnamediv>
<refname>xml_get_error_code</refname>
<refpurpose>Get XML parser error code</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -15,6 +16,7 @@
Gets the XML parser error code.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -30,6 +32,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -39,6 +42,7 @@
section</link>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -47,6 +51,7 @@
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

73
reference/xml/functions/xml-parse-into-struct.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<refentry id="function.xml-parse-into-struct">
<refnamediv>
<refname>xml_parse_into_struct</refname>
<refpurpose>Parse XML data into an array structure</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>xml_parse_into_struct</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -15,19 +16,60 @@
<methodparam choice="opt"><type>array</type><parameter role="reference">index</parameter></methodparam>
</methodsynopsis>
<para>
This function parses an XML file into 2 parallel array
structures, one (<parameter>index</parameter>) containing pointers
to the location of the appropriate values in the
<parameter>values</parameter> array. These last two parameters
must be passed by reference.
This function parses an XML file into 2 parallel array structures, one
(<parameter>index</parameter>) containing pointers to the location of the
appropriate values in the <parameter>values</parameter> array. These last
two parameters must be passed by reference.
</para>
<note>
<para>
<function>xml_parse_into_struct</function> returns 0 for
failure and 1 for success. This is not the same as &false;
and &true;, be careful with operators such as ===.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>xml_parse_into_struct</function> returns 0 for failure and 1 for
success. This is not the same as &false; and &true;, be careful with
operators such as ===.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Below is an example that illustrates the internal structure of
the arrays being generated by the function. We use a simple
@ -234,6 +276,7 @@ Array
</informalexample>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

6
reference/xml/functions/xml-parse.xml
View file

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry id="function.xml-parse">
<refnamediv>
<refname>xml_parse</refname>
<refpurpose>Start parsing an XML document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -18,6 +19,7 @@
the configured events are called as many times as necessary.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -53,6 +55,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -73,6 +76,7 @@
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

79
reference/xml/functions/xml-parser-create-ns.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry id='function.xml-parser-create-ns'>
<refnamediv>
<refname>xml_parser_create_ns</refname>
<refpurpose>Create an XML parser with namespace support</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>xml_parser_create_ns</methodname>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
@ -17,30 +18,60 @@
with XML namespace support and returns a resource handle referencing
it to be used by the other XML functions.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
With a namespace aware parser tag parameters passed to the
various handler functions will consist of namespace and tag name
separated by the string specified in
<parameter>seperator</parameter> or <literal>':'</literal> by
default.
</para>
<para>
The optional <parameter>encoding</parameter> specifies the character
encoding for the input/output in PHP 4. Starting from PHP 5, the input
encoding is automatically detected, so that the
<parameter>encoding</parameter> parameter specifies only the output
encoding. In PHP 4, the default output encoding is the same as the
input charset. In PHP 5.0.0 and 5.0.1, the default output charset is
ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
encodings are <literal>ISO-8859-1</literal>, <literal>UTF-8</literal> and
<literal>US-ASCII</literal>.
</para>
<para>
See also
<function>xml_parser_create</function>, and
<function>xml_parser_free</function>.
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The optional <parameter>encoding</parameter> specifies the character
encoding for the input/output in PHP 4. Starting from PHP 5, the input
encoding is automatically detected, so that the
<parameter>encoding</parameter> parameter specifies only the output
encoding. In PHP 4, the default output encoding is the same as the
input charset. In PHP 5.0.0 and 5.0.1, the default output charset is
ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
encodings are <literal>ISO-8859-1</literal>, <literal>UTF-8</literal> and
<literal>US-ASCII</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>separator</parameter></term>
<listitem>
<para>
With a namespace aware parser tag parameters passed to the various
handler functions will consist of namespace and tag name separated by
the string specified in <parameter>seperator</parameter> or
<literal>':'</literal> by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a resource handle for the new XML parser.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>xml_parser_create</function></member>
<member><function>xml_parser_free</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

64
reference/xml/functions/xml-parser-create.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<refentry id="function.xml-parser-create">
<refnamediv>
<refname>xml_parser_create</refname>
<refpurpose>Create an XML parser</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>xml_parser_create</methodname>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
@ -16,24 +17,51 @@
and returns a resource handle referencing it to be used by the
other XML functions.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The optional <parameter>encoding</parameter> specifies the character
encoding for the input/output in PHP 4. Starting from PHP 5, the input
encoding is automatically detected, so that the
<parameter>encoding</parameter> parameter specifies only the output
encoding. In PHP 4, the default output encoding is the same as the
input charset. If empty string is passed, the parser attempts to identify
which encoding the document is encoded in by looking at the heading 3 or
4 bytes. In PHP 5.0.0 and 5.0.1, the default output charset is
ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
encodings are <literal>ISO-8859-1</literal>, <literal>UTF-8</literal> and
<literal>US-ASCII</literal>.
</para>
<para>
See also <function>xml_parser_create_ns</function> and
<function>xml_parser_free</function>.
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The optional <parameter>encoding</parameter> specifies the character
encoding for the input/output in PHP 4. Starting from PHP 5, the input
encoding is automatically detected, so that the
<parameter>encoding</parameter> parameter specifies only the output
encoding. In PHP 4, the default output encoding is the same as the
input charset. If empty string is passed, the parser attempts to identify
which encoding the document is encoded in by looking at the heading 3 or
4 bytes. In PHP 5.0.0 and 5.0.1, the default output charset is
ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
encodings are <literal>ISO-8859-1</literal>, <literal>UTF-8</literal> and
<literal>US-ASCII</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a resource handle for the new XML parser.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>xml_parser_create_ns</function></member>
<member><function>xml_parser_free</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

10
reference/xml/functions/xml-parser-free.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.xml-parser-free">
<refnamediv>
<refname>xml_parser_free</refname>
<refpurpose>Free an XML parser</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_parser_free</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -15,6 +16,7 @@
Frees the given XML <parameter>parser</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -30,6 +32,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -37,6 +40,7 @@
refer to a valid parser, or else it frees the parser and returns &true;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

10
reference/xml/functions/xml-parser-get-option.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.xml-parser-get-option">
<refnamediv>
<refname>xml_parser_get_option</refname>
<refpurpose>Get options from an XML parser</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>xml_parser_get_option</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -16,6 +17,7 @@
Gets an option value from an XML parser.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -41,6 +43,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -50,6 +53,7 @@
Else the option's value is returned.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

137
reference/xml/functions/xml-parser-set-option.xml
View file

@ -1,104 +1,117 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.xml-parser-set-option">
<refnamediv>
<refname>xml_parser_set_option</refname>
<refpurpose>Set options in an XML parser</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<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>
Sets an option in an XML parser.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<simpara>
<para>
A reference to the XML parser to set an option in.
</simpara>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<simpara>
<para>
Which option to set. See below.
</simpara>
</para>
<para>
The following options are available:
<table>
<title>XML parser options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Option constant</entry>
<entry>Data type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>XML_OPTION_CASE_FOLDING</constant></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><constant>XML_OPTION_SKIP_TAGSTART</constant></entry>
<entry>integer</entry>
<entry>
Specify how many characters should be skipped in the beginning of a
tag name.
</entry>
</row>
<row>
<entry><constant>XML_OPTION_SKIP_WHITE</constant></entry>
<entry>integer</entry>
<entry>
Whether to skip values consisting of whitespace characters.
</entry>
</row>
<row>
<entry><constant>XML_OPTION_TARGET_ENCODING</constant></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>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<simpara>
The option's new value.
</simpara>
<para>
The option's new value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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.
</para>
<para>
The following options are available:
<table>
<title>XML parser options</title>
<tgroup cols="3">
<thead>
<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_SKIP_TAGSTART</entry>
<entry>integer</entry>
<entry>
Specify how many characters should be skipped in the beginning of a
tag name.
</entry>
</row>
<row>
<entry>XML_OPTION_SKIP_WHITE</entry>
<entry>integer</entry>
<entry>
Whether to skip values consisting of whitespace characters.
</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>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

90
reference/xml/functions/xml-set-character-data-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.xml-set-character-data-handler">
<refnamediv>
<refname>xml_set_character_data_handler</refname>
<refpurpose>Set up character data handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_character_data_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -14,49 +15,76 @@
</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
<function>xml_parse</function> is called for
<parameter>parser</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The function named by <parameter>handler</parameter> must accept
two parameters:
<methodsynopsis>
<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>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<term><parameter>handler</parameter></term>
<listitem>
<simpara>
The second parameter, <parameter>data</parameter>, contains
the character data as a string.
</simpara>
<para>
<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>
The function named by <parameter>handler</parameter> must accept
two parameters:
<methodsynopsis>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<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.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist></para>
<para>
If a handler function is set to an empty string, or &false;, the handler
in question is disabled.
</variablelist>
</para>
<para>
&true; is returned if the handler is set up, &false; if
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

103
reference/xml/functions/xml-set-default-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.xml-set-default-handler">
<refnamediv>
<refname>xml_set_default_handler</refname>
<refpurpose>Set up default handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_default_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -14,56 +15,82 @@
</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
<function>xml_parse</function> is called for
<parameter>parser</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The function named by <parameter>handler</parameter> must accept
two parameters:
<methodsynopsis>
<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>
<term><parameter>parser</parameter></term>
<listitem>
<simpara>
The first parameter, <replaceable>parser</replaceable>, is a
reference to the XML parser calling the handler.
</simpara>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>data</parameter>
</term>
<term><parameter>handler</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>
<para>
<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>
The function named by <parameter>handler</parameter> must accept
two parameters:
<methodsynopsis>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>
<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>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
If a handler function is set to an empty string, or &false;, the handler
in question is disabled.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
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
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

228
reference/xml/functions/xml-set-element-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.xml-set-element-handler">
<refnamediv>
<refname>xml_set_element_handler</refname>
<refpurpose>Set up start and end element handlers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_element_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -14,107 +15,134 @@
<methodparam><type>callback</type><parameter>end_element_handler</parameter></methodparam>
</methodsynopsis>
<para>
Sets the element handler functions for the XML parser
<parameter>parser</parameter>.
Sets the element handler functions for the XML <parameter>parser</parameter>.
<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>.
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>start_element_handler</parameter>
must accept three parameters:
<methodsynopsis>
<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>
</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>
</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>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The function named by <parameter>end_element_handler</parameter>
must accept two parameters:
<methodsynopsis>
<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>
</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>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
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
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start_element_handler</parameter></term>
<listitem>
<para>
The function named by <parameter>start_element_handler</parameter>
must accept three parameters:
<methodsynopsis>
<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>
</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>
</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>
</listitem>
</varlistentry>
</variablelist>
</para>
&note.func-callback;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_element_handler</parameter></term>
<listitem>
<para>
The function named by <parameter>end_element_handler</parameter>
must accept two parameters:
<methodsynopsis>
<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>
</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>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
If a handler function is set to an empty string, or &false;, the handler
in question is disabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/xml/functions/xml-set-end-namespace-decl-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id='function.xml-set-end-namespace-decl-handler'>
<refnamediv>
<refname>xml_set_end_namespace_decl_handler</refname>
<refpurpose>Set up end namespace declaration handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_end_namespace_decl_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -15,6 +16,14 @@
&warn.undocumented.func;
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

169
reference/xml/functions/xml-set-external-entity-ref-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.xml-set-external-entity-ref-handler">
<refnamediv>
<refname>xml_set_external_entity_ref_handler</refname>
<refpurpose>Set up external entity reference handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_external_entity_ref_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -14,90 +15,116 @@
</methodsynopsis>
<para>
Sets the external entity reference 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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The function named by <parameter>handler</parameter> must accept
five parameters, and should return an integer value.If the
value returned from the handler is &false; (which it will be if no
value is returned), the XML parser will stop parsing and
<function>xml_get_error_code</function> will return <systemitem
class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>.
<methodsynopsis>
<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>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open_entity_names</parameter></term>
<term><parameter>handler</parameter></term>
<listitem>
<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>system_id</parameter>) of the external entity.Currently
this parameter will always be set to an empty string.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>system_id</parameter></term>
<listitem>
<simpara>
The fourth parameter, <parameter>system_id</parameter>, is the
system identifier as specified in the entity declaration.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>public_id</parameter></term>
<listitem>
<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>
<para>
<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>
The function named by <parameter>handler</parameter> must accept
five parameters, and should return an integer value.If the
value returned from the handler is &false; (which it will be if no
value is returned), the XML parser will stop parsing and
<function>xml_get_error_code</function> will return <systemitem
class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>.
<methodsynopsis>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open_entity_names</parameter></term>
<listitem>
<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>system_id</parameter>) of the external entity.Currently
this parameter will always be set to an empty string.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>system_id</parameter></term>
<listitem>
<simpara>
The fourth parameter, <parameter>system_id</parameter>, is the
system identifier as specified in the entity declaration.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>public_id</parameter></term>
<listitem>
<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.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
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
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

161
reference/xml/functions/xml-set-notation-decl-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.xml-set-notation-decl-handler">
<refnamediv>
<refname>xml_set_notation_decl_handler</refname>
<refpurpose>Set up notation declaration handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_notation_decl_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -14,9 +15,6 @@
</methodsynopsis>
<para>
Sets the notation 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>
@ -31,80 +29,109 @@
See <ulink url="&url.rec-xml;#Notations">section 4.7 of the XML 1.0
spec</ulink> for the definition of notation declarations.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The function named by <parameter>handler</parameter> must accept
five parameters:
<methodsynopsis>
<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>
</term>
<term><parameter>parser</parameter></term>
<listitem>
<simpara>
The first parameter, <replaceable>parser</replaceable>, is a
reference to the XML parser calling the handler.
</simpara>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>notation_name</parameter></term>
<term><parameter>handler</parameter></term>
<listitem>
<simpara>
This is the notation's <parameter>name</parameter>, as per
the notation format described above.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<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>system_id</parameter></term>
<listitem>
<simpara>
System identifier of the external notation declaration.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>public_id</parameter>
</term>
<listitem>
<simpara>
Public identifier of the external notation declaration.
</simpara>
<para>
<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>
The function named by <parameter>handler</parameter> must accept
five parameters:
<methodsynopsis>
<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>
</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>notation_name</parameter></term>
<listitem>
<simpara>
This is the notation's <parameter>name</parameter>, as per
the notation format described above.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<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>system_id</parameter></term>
<listitem>
<simpara>
System identifier of the external notation declaration.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>public_id</parameter>
</term>
<listitem>
<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.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
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
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/xml/functions/xml-set-object.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- $Revision: 1.14 $ -->
<refentry id="function.xml-set-object">
<refnamediv>
<refname>xml_set_object</refname>
<refpurpose>Use XML Parser within an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_object</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -18,6 +19,39 @@
<function>xml_set_element_handler</function> etc and assumed to be
methods of <parameter>object</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>xml_set_object</function> example</title>
@ -66,6 +100,7 @@ $xml_parser->parse("<A ID='hallo'>PHP</A>");
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

109
reference/xml/functions/xml-set-processing-instruction-handler.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.xml-set-processing-instruction-handler">
<refnamediv>
<refname>xml_set_processing_instruction_handler</refname>
@ -7,8 +7,9 @@
Set up processing instruction (PI) handler
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_processing_instruction_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -16,9 +17,6 @@
</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>.
</para>
<para>
@ -34,55 +32,84 @@
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The function named by <parameter>handler</parameter> must accept
three parameters:
<methodsynopsis>
<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>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
<term><parameter>handler</parameter></term>
<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>
<para>
<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>
The function named by <parameter>handler</parameter> must accept
three parameters:
<methodsynopsis>
<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>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
<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>
</varlistentry>
</variablelist>
</para>
<para>
If a handler function is set to an empty string, or &false;, the handler
in question is disabled.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
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
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/xml/functions/xml-set-start-namespace-decl-handler.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 -->
<!-- $Revision: 1.7 $ -->
<refentry id='function.xml-set-start-namespace-decl-handler'>
<refnamediv>
<refname>xml_set_start_namespace_decl_handler</refname>
@ -8,8 +7,9 @@
Set up start namespace declaration handler
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -18,6 +18,14 @@
&warn.undocumented.func;
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

173
reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.xml-set-unparsed-entity-decl-handler">
<refnamediv>
<refname>xml_set_unparsed_entity_decl_handler</refname>
@ -7,8 +7,9 @@
Set up unparsed entity declaration handler
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@ -16,15 +17,12 @@
</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>
<para>
This handler will be called if the XML parser encounters an
external entity declaration with an NDATA declaration, like the
following:
The <parameter>handler</parameter> will be called if the XML parser
encounters an external entity declaration with an NDATA declaration, like
the following:
<programlisting role="xml">
<![CDATA[
<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
@ -37,84 +35,113 @@
the XML 1.0 spec</ulink> for the definition of notation declared
external entities.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The function named by <parameter>handler</parameter> must accept six
parameters:
<methodsynopsis>
<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>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entity_name</parameter></term>
<term><parameter>handler</parameter></term>
<listitem>
<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>
</varlistentry>
<varlistentry>
<term><parameter>system_id</parameter></term>
<listitem>
<simpara>
System identifier for the external entity.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>public_id</parameter></term>
<listitem>
<simpara>
Public identifier for the external entity.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>notation_name</parameter></term>
<listitem>
<simpara>
Name of the notation of this entity (see
<function>xml_set_notation_decl_handler</function>).
</simpara>
<para>
<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>
The function named by <parameter>handler</parameter> must accept six
parameters:
<methodsynopsis>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entity_name</parameter></term>
<listitem>
<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>
</varlistentry>
<varlistentry>
<term><parameter>system_id</parameter></term>
<listitem>
<simpara>
System identifier for the external entity.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>public_id</parameter></term>
<listitem>
<simpara>
Public identifier for the external entity.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>notation_name</parameter></term>
<listitem>
<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.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
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
<parameter>parser</parameter> is not a parser.
</para>
&note.func-callback;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file