cvs: 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

didou Mon Jan 8 02:22:13 2007 UTC 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: Clean whitespaces

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/utf8-decode.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xml/functions/utf8-decode.xml diff -u phpdoc/en/reference/xml/functions/utf8-decode.xml:1.6 phpdoc/en/reference/xml/functions/utf8-decode.xml:1.7 --- phpdoc/en/reference/xml/functions/utf8-decode.xml:1.6 Fri Aug 20 09:37:01 2004 +++ phpdoc/en/reference/xml/functions/utf8-decode.xml Mon Jan 8 02:22:13 2007 @@ -1,31 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - </refnamediv> - <refsect1> - <title>Description</title> - <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>. - </para> - <para> - See also - <function>utf8_encode</function> for an explanation of UTF-8 - encoding. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<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> + </refnamediv> + <refsect1> + <title>Description</title> + <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>. + </para> + <para> + See also + <function>utf8_encode</function> for an explanation of UTF-8 + encoding. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/utf8-encode.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xml/functions/utf8-encode.xml diff -u phpdoc/en/reference/xml/functions/utf8-encode.xml:1.5 phpdoc/en/reference/xml/functions/utf8-encode.xml:1.6 --- phpdoc/en/reference/xml/functions/utf8-encode.xml:1.5 Mon Mar 29 14:35:03 2004 +++ phpdoc/en/reference/xml/functions/utf8-encode.xml Mon Jan 8 02:22:13 2007 @@ -1,67 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <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: - <table> - <title>UTF-8 encoding</title> - <tgroup cols="3"> - <thead> - <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> - </tbody> - </tgroup> - </table> - Each <replaceable>b</replaceable> represents a bit that can be - used to store character data. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <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: + <table> + <title>UTF-8 encoding</title> + <tgroup cols="3"> + <thead> + <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> + </tbody> + </tgroup> + </table> + Each <replaceable>b</replaceable> represents a bit that can be + used to store character data. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-error-string.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-error-string.xml diff -u phpdoc/en/reference/xml/functions/xml-error-string.xml:1.6 phpdoc/en/reference/xml/functions/xml-error-string.xml:1.7 --- phpdoc/en/reference/xml/functions/xml-error-string.xml:1.6 Sun Feb 6 00:41:24 2005 +++ phpdoc/en/reference/xml/functions/xml-error-string.xml Mon Jan 8 02:22:13 2007 @@ -1,52 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <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> - <type>string</type><methodname>xml_error_string</methodname> - <methodparam><type>int</type><parameter>code</parameter></methodparam> - </methodsynopsis> - <para> - Gets the XML parser error string associated with the given - <parameter>code</parameter>. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>code</parameter></term> - <listitem> - <para> - An error code from <function>xml_get_error_code</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a string with a textual description of the error - <parameter>code</parameter>, or &false; if no description was found. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>xml_get_error_code</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<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> + <type>string</type><methodname>xml_error_string</methodname> + <methodparam><type>int</type><parameter>code</parameter></methodparam> + </methodsynopsis> + <para> + Gets the XML parser error string associated with the given + <parameter>code</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>code</parameter></term> + <listitem> + <para> + An error code from <function>xml_get_error_code</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string with a textual description of the error + <parameter>code</parameter>, or &false; if no description was found. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_get_error_code</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml?r1=1.6&r2=1.7&diff_format=u 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.6 phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.7 --- phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.6 Tue Mar 7 01:18:09 2006 +++ phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml Mon Jan 8 02:22:13 2007 @@ -1,62 +1,62 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <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> - <type>int</type><methodname>xml_get_current_byte_index</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - </methodsynopsis> - <para> - Gets the current byte index of the given XML parser. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <para> - A reference to the XML parser to get byte index from. - </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 else it returns which byte index - the parser is currently at in its data buffer (starting at 0). - </para> - </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <warning> - <para> - This function returns byte index according to UTF-8 encoded text - disregarding if input is in another encoding. - </para> - </warning> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>xml_get_current_column_index</function></member> - <member><function>xml_get_current_line_index</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<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> + <type>int</type><methodname>xml_get_current_byte_index</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + </methodsynopsis> + <para> + Gets the current byte index of the given XML parser. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser to get byte index from. + </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 else it returns which byte index + the parser is currently at in its data buffer (starting at 0). + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <warning> + <para> + This function returns byte index according to UTF-8 encoded text + disregarding if input is in another encoding. + </para> + </warning> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_get_current_column_index</function></member> + <member><function>xml_get_current_line_index</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml?r1=1.4&r2=1.5&diff_format=u 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.4 phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.5 --- phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.4 Sun Feb 6 00:41:24 2005 +++ phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml Mon Jan 8 02:22:13 2007 @@ -1,57 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.xml-get-current-column-number"> - <refnamediv> - <refname>xml_get_current_column_number</refname> - <refpurpose> - Get current column number for an XML parser - </refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>xml_get_current_column_number</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - </methodsynopsis> - <para> - Gets the current column number of the given XML parser. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <para> - A reference to the XML parser to get column number from. - </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 else it returns which column on - the current line (as given by - <function>xml_get_current_line_number</function>) the parser is - currently at. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>xml_get_current_byte_index</function></member> - <member><function>xml_get_current_line_index</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.xml-get-current-column-number"> + <refnamediv> + <refname>xml_get_current_column_number</refname> + <refpurpose> + Get current column number for an XML parser + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>xml_get_current_column_number</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + </methodsynopsis> + <para> + Gets the current column number of the given XML parser. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser to get column number from. + </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 else it returns which column on + the current line (as given by + <function>xml_get_current_line_number</function>) the parser is + currently at. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_get_current_byte_index</function></member> + <member><function>xml_get_current_line_index</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml?r1=1.5&r2=1.6&diff_format=u 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.5 phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.5 Sun Feb 6 00:41:24 2005 +++ phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml Mon Jan 8 02:22:13 2007 @@ -1,53 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <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> - <type>int</type><methodname>xml_get_current_line_number</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - </methodsynopsis> - <para> - Gets the current line number for the given XML parser. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <para> - A reference to the XML parser to get line number from. - </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 else it returns which line the - parser is currently at in its data buffer. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>xml_get_current_column_index</function></member> - <member><function>xml_get_current_byte_index</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <type>int</type><methodname>xml_get_current_line_number</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + </methodsynopsis> + <para> + Gets the current line number for the given XML parser. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser to get line number from. + </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 else it returns which line the + parser is currently at in its data buffer. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_get_current_column_index</function></member> + <member><function>xml_get_current_byte_index</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-get-error-code.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-get-error-code.xml diff -u phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.6 phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.7 --- phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.6 Sun Feb 6 00:41:24 2005 +++ phpdoc/en/reference/xml/functions/xml-get-error-code.xml Mon Jan 8 02:22:13 2007 @@ -1,53 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <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> - <type>int</type><methodname>xml_get_error_code</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - </methodsynopsis> - <para> - Gets the XML parser error code. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <para> - A reference to the XML parser to get error code from. - </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 else it returns one of the error - codes listed in the <link linkend="xml.error-codes">error codes - section</link>. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>xml_error_string</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<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> + <type>int</type><methodname>xml_get_error_code</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + </methodsynopsis> + <para> + Gets the XML parser error code. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser to get error code from. + </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 else it returns one of the error + codes listed in the <link linkend="xml.error-codes">error codes + section</link>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_error_string</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml?r1=1.13&r2=1.14&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml diff -u phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml:1.13 phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml:1.14 --- phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml:1.13 Fri Jul 1 13:07:50 2005 +++ phpdoc/en/reference/xml/functions/xml-parse-into-struct.xml Mon Jan 8 02:22:13 2007 @@ -1,43 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.11 --> - <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> - <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 role="reference">values</parameter></methodparam> - <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. - </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> - <para> - Below is an example that illustrates the internal structure of - the arrays being generated by the function. We use a simple - <literal>note</literal> tag embedded inside a - <literal>para</literal> tag, and then we parse this and print out - the structures generated: - <example> - <title><function>xml_parse_into_struct</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.14 $ --> +<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> + <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 role="reference">values</parameter></methodparam> + <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. + </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> + <para> + Below is an example that illustrates the internal structure of + the arrays being generated by the function. We use a simple + <literal>note</literal> tag embedded inside a + <literal>para</literal> tag, and then we parse this and print out + the structures generated: + <example> + <title><function>xml_parse_into_struct</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $simple = "<para><note>simple note</note></para>"; @@ -50,11 +49,11 @@ print_r($vals); ?> ]]> - </programlisting> - <para> - When we run that code, the output will be: - </para> - <screen> + </programlisting> + <para> + When we run that code, the output will be: + </para> + <screen> <![CDATA[ Index array Array @@ -99,50 +98,50 @@ ) ]]> - </screen> - </example> - </para> - <para> - Event-driven parsing (based on the expat library) can get - complicated when you have an XML document that is complex. - This function does not produce a DOM style object, but it - generates structures amenable of being transversed in a tree - fashion. Thus, we can create objects representing the data - in the XML file easily. Let's consider the following XML file - representing a small database of aminoacids information: - <example> - <title>moldb.xml - small database of molecular information</title> - <programlisting role="xml"> + </screen> + </example> + </para> + <para> + Event-driven parsing (based on the expat library) can get + complicated when you have an XML document that is complex. + This function does not produce a DOM style object, but it + generates structures amenable of being transversed in a tree + fashion. Thus, we can create objects representing the data + in the XML file easily. Let's consider the following XML file + representing a small database of aminoacids information: + <example> + <title>moldb.xml - small database of molecular information</title> + <programlisting role="xml"> <![CDATA[ <?xml version="1.0"?> <moldb> - <molecule> - <name>Alanine</name> - <symbol>ala</symbol> - <code>A</code> - <type>hydrophobic</type> - </molecule> - - <molecule> - <name>Lysine</name> - <symbol>lys</symbol> - <code>K</code> - <type>charged</type> - </molecule> + <molecule> + <name>Alanine</name> + <symbol>ala</symbol> + <code>A</code> + <type>hydrophobic</type> + </molecule> + + <molecule> + <name>Lysine</name> + <symbol>lys</symbol> + <code>K</code> + <type>charged</type> + </molecule> </moldb> ]]> - </programlisting> - </example> - And some code to parse the document and generate the appropriate - objects: - <example> - <title> - parsemoldb.php - parses moldb.xml into an array of - molecular objects - </title> - <programlisting role="php"> + </programlisting> + </example> + And some code to parse the document and generate the appropriate + objects: + <example> + <title> + parsemoldb.php - parses moldb.xml into an array of + molecular objects + </title> + <programlisting role="php"> <![CDATA[ <?php @@ -201,14 +200,14 @@ ?> ]]> - </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> + </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> <![CDATA[ ** Database of AminoAcid objects: Array @@ -231,11 +230,11 @@ ) ]]> - </screen> - </informalexample> - </para> - </refsect1> - </refentry> + </screen> + </informalexample> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parse.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parse.xml diff -u phpdoc/en/reference/xml/functions/xml-parse.xml:1.8 phpdoc/en/reference/xml/functions/xml-parse.xml:1.9 --- phpdoc/en/reference/xml/functions/xml-parse.xml:1.8 Fri Jun 9 20:26:04 2006 +++ phpdoc/en/reference/xml/functions/xml-parse.xml Mon Jan 8 02:22:13 2007 @@ -1,79 +1,79 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> - <refentry id="function.xml-parse"> - <refnamediv> - <refname>xml_parse</refname> - <refpurpose>Start parsing an XML document</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</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> - <function>xml_parse</function> parses an XML document. The handlers for - the configured events are called as many times as necessary. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <para> - A reference to the XML parser to use. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <para> - 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. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>is_final</parameter></term> - <listitem> - <para> - If set and &true;, <parameter>data</parameter> is the last piece of - data sent in this parse. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns 1 on success or 0 on failure. - </para> - <para> - For unsuccessful parses, error information can be retrieved with - <function>xml_get_error_code</function>, - <function>xml_error_string</function>, - <function>xml_get_current_line_number</function>, - <function>xml_get_current_column_number</function> and - <function>xml_get_current_byte_index</function>. - </para> - <note> - <para> - Entity errors are reported at the end of the data thus only if - <parameter>is_final</parameter> is set and &true;. - </para> - </note> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<refentry id="function.xml-parse"> + <refnamediv> + <refname>xml_parse</refname> + <refpurpose>Start parsing an XML document</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</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> + <function>xml_parse</function> parses an XML document. The handlers for + the configured events are called as many times as necessary. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser to use. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>is_final</parameter></term> + <listitem> + <para> + If set and &true;, <parameter>data</parameter> is the last piece of + data sent in this parse. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns 1 on success or 0 on failure. + </para> + <para> + For unsuccessful parses, error information can be retrieved with + <function>xml_get_error_code</function>, + <function>xml_error_string</function>, + <function>xml_get_current_line_number</function>, + <function>xml_get_current_column_number</function> and + <function>xml_get_current_byte_index</function>. + </para> + <note> + <para> + Entity errors are reported at the end of the data thus only if + <parameter>is_final</parameter> is set and &true;. + </para> + </note> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml diff -u phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml:1.8 phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml:1.9 --- phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml:1.8 Wed Sep 15 19:12:40 2004 +++ phpdoc/en/reference/xml/functions/xml-parser-create-ns.xml Mon Jan 8 02:22:13 2007 @@ -1,50 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 --> - <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> - <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>separator</parameter></methodparam> - </methodsynopsis> - <para> - <function>xml_parser_create_ns</function> creates a new XML parser - with XML namespace support and returns a resource handle referencing - it to be used by the other XML functions. - </para> - <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>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<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> + <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>separator</parameter></methodparam> + </methodsynopsis> + <para> + <function>xml_parser_create_ns</function> creates a new XML parser + with XML namespace support and returns a resource handle referencing + it to be used by the other XML functions. + </para> + <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>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parser-create.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parser-create.xml diff -u phpdoc/en/reference/xml/functions/xml-parser-create.xml:1.9 phpdoc/en/reference/xml/functions/xml-parser-create.xml:1.10 --- phpdoc/en/reference/xml/functions/xml-parser-create.xml:1.9 Fri Sep 17 13:30:25 2004 +++ phpdoc/en/reference/xml/functions/xml-parser-create.xml Mon Jan 8 02:22:13 2007 @@ -1,41 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <refentry id="function.xml-parser-create"> - <refnamediv> - <refname>xml_parser_create</refname> - <refpurpose>Create an XML parser</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>xml_parser_create</methodname> - <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> - </methodsynopsis> - <para> - <function>xml_parser_create</function> creates a new XML parser - and returns a resource handle referencing it to be used by the - other XML functions. - </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. 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>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.10 $ --> +<refentry id="function.xml-parser-create"> + <refnamediv> + <refname>xml_parser_create</refname> + <refpurpose>Create an XML parser</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>xml_parser_create</methodname> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> + <para> + <function>xml_parser_create</function> creates a new XML parser + and returns a resource handle referencing it to be used by the + other XML functions. + </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. 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>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parser-free.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parser-free.xml diff -u phpdoc/en/reference/xml/functions/xml-parser-free.xml:1.4 phpdoc/en/reference/xml/functions/xml-parser-free.xml:1.5 --- phpdoc/en/reference/xml/functions/xml-parser-free.xml:1.4 Sun Jan 7 17:07:15 2007 +++ phpdoc/en/reference/xml/functions/xml-parser-free.xml Mon Jan 8 02:22:13 2007 @@ -1,44 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <refentry id="function.xml-parser-free"> - <refnamediv> - <refname>xml_parser_free</refname> - <refpurpose>Free an XML parser</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>xml_parser_free</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - </methodsynopsis> - <para> - Frees the given XML <parameter>parser</parameter>. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - A reference to the XML parser to free. - </simpara> - </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 else it frees the parser and returns &true;. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.xml-parser-free"> + <refnamediv> + <refname>xml_parser_free</refname> + <refpurpose>Free an XML parser</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>xml_parser_free</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + </methodsynopsis> + <para> + Frees the given XML <parameter>parser</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + A reference to the XML parser to free. + </simpara> + </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 else it frees the parser and returns &true;. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parser-get-option.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parser-get-option.xml diff -u phpdoc/en/reference/xml/functions/xml-parser-get-option.xml:1.7 phpdoc/en/reference/xml/functions/xml-parser-get-option.xml:1.8 --- phpdoc/en/reference/xml/functions/xml-parser-get-option.xml:1.7 Sun Jan 7 17:07:15 2007 +++ phpdoc/en/reference/xml/functions/xml-parser-get-option.xml Mon Jan 8 02:22:13 2007 @@ -1,57 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <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> - Gets an option value from an XML parser. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <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. <constant>XML_OPTION_CASE_FOLDING</constant> - and <constant>XML_OPTION_TARGET_ENCODING</constant> are available. - See <function>xml_parser_set_option</function> for their description. - </simpara> - </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 <parameter>option</parameter> isn't - valid (generates also a <constant>E_WARNING</constant>). - Else the option's value is returned. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<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> + <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> + Gets an option value from an XML parser. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <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. <constant>XML_OPTION_CASE_FOLDING</constant> + and <constant>XML_OPTION_TARGET_ENCODING</constant> are available. + See <function>xml_parser_set_option</function> for their description. + </simpara> + </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 <parameter>option</parameter> isn't + valid (generates also a <constant>E_WARNING</constant>). + Else the option's value is returned. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-parser-set-option.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-parser-set-option.xml diff -u phpdoc/en/reference/xml/functions/xml-parser-set-option.xml:1.6 phpdoc/en/reference/xml/functions/xml-parser-set-option.xml:1.7 --- phpdoc/en/reference/xml/functions/xml-parser-set-option.xml:1.6 Tue Jun 7 14:15:11 2005 +++ phpdoc/en/reference/xml/functions/xml-parser-set-option.xml Mon Jan 8 02:22:13 2007 @@ -1,106 +1,105 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <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> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>option</parameter></term> - <listitem> - <simpara> - Which option to set. See below. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <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. - </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> +<!-- $Revision: 1.7 $ --> +<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> + <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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + Which option to set. See below. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <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. + </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 Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml?r1=1.5&r2=1.6&diff_format=u 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.5 phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml:1.5 Mon Mar 29 14:35:03 2004 +++ phpdoc/en/reference/xml/functions/xml-set-character-data-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,64 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_character_data_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</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 - <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> - <para> - &true; is returned if the handler is set up, &false; if - <parameter>parser</parameter> is not a parser. - </para> - &note.func-callback; - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_character_data_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</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 + <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> + <para> + &true; is returned if the handler is set up, &false; if + <parameter>parser</parameter> is not a parser. + </para> + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-default-handler.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-default-handler.xml diff -u phpdoc/en/reference/xml/functions/xml-set-default-handler.xml:1.5 phpdoc/en/reference/xml/functions/xml-set-default-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-default-handler.xml:1.5 Mon Mar 29 14:35:03 2004 +++ phpdoc/en/reference/xml/functions/xml-set-default-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,71 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_default_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</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 - <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> - <para> - &true; is returned if the handler is set up, &false; if - <parameter>parser</parameter> is not a parser. - </para> - &note.func-callback; - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_default_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</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 + <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> + <para> + &true; is returned if the handler is set up, &false; if + <parameter>parser</parameter> is not a parser. + </para> + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-element-handler.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-element-handler.xml diff -u phpdoc/en/reference/xml/functions/xml-set-element-handler.xml:1.5 phpdoc/en/reference/xml/functions/xml-set-element-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-element-handler.xml:1.5 Mon Mar 29 14:35:03 2004 +++ phpdoc/en/reference/xml/functions/xml-set-element-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,122 +1,121 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_element_handler</methodname> +<!-- $Revision: 1.6 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_element_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</type><parameter>start_element_handler</parameter></methodparam> + <methodparam><type>callback</type><parameter>end_element_handler</parameter></methodparam> + </methodsynopsis> + <para> + Sets the element handler functions for the XML parser + <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>. + </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>callback</type><parameter>start_element_handler</parameter></methodparam> - <methodparam><type>callback</type><parameter>end_element_handler</parameter></methodparam> - </methodsynopsis> - <para> - Sets the element handler functions for the XML parser - <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>. - </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> - </refentry> + <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> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml?r1=1.5&r2=1.6&diff_format=u 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.5 phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.5 Mon Mar 29 13:11:56 2004 +++ phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,26 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_end_namespace_decl_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</type><parameter>handler</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - &note.func-callback; - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_end_namespace_decl_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</type><parameter>handler</parameter></methodparam> + </methodsynopsis> + &warn.undocumented.func; + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml?r1=1.6&r2=1.7&diff_format=u 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.6 phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml:1.7 --- phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml:1.6 Mon Mar 29 14:35:03 2004 +++ phpdoc/en/reference/xml/functions/xml-set-external-entity-ref-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,105 +1,104 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_external_entity_ref_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</type><parameter>handler</parameter></methodparam> - </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> - <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> - <para> - &true; is returned if the handler is set up, &false; if - <parameter>parser</parameter> is not a parser. - </para> - &note.func-callback; - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_external_entity_ref_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</type><parameter>handler</parameter></methodparam> + </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> + <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> + <para> + &true; is returned if the handler is set up, &false; if + <parameter>parser</parameter> is not a parser. + </para> + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml?r1=1.6&r2=1.7&diff_format=u 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.6 phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml:1.7 --- phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml:1.6 Mon Mar 29 14:35:03 2004 +++ phpdoc/en/reference/xml/functions/xml-set-notation-decl-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,112 +1,111 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_notation_decl_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</type><parameter>handler</parameter></methodparam> - </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> - A notation declaration is part of the document's DTD and has the - following format: <programlisting role="xml"> +<!-- $Revision: 1.7 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_notation_decl_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</type><parameter>handler</parameter></methodparam> + </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> + A notation declaration is part of the document's DTD and has the + following format: + <programlisting role="xml"> <![CDATA[ <!NOTATION <parameter>name</parameter> { <parameter>systemId</parameter> | <parameter>publicId</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> - <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 + </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> + <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> - <para> - &true; is returned if the handler is set up, &false; if - <parameter>parser</parameter> is not a parser. - </para> - &note.func-callback; - </refsect1> - </refentry> + 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> + <para> + &true; is returned if the handler is set up, &false; if + <parameter>parser</parameter> is not a parser. + </para> + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-object.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-object.xml diff -u phpdoc/en/reference/xml/functions/xml-set-object.xml:1.12 phpdoc/en/reference/xml/functions/xml-set-object.xml:1.13 --- phpdoc/en/reference/xml/functions/xml-set-object.xml:1.12 Fri Jun 24 09:11:47 2005 +++ phpdoc/en/reference/xml/functions/xml-set-object.xml Mon Jan 8 02:22:13 2007 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>xml_set_object</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>object</type><parameter role="reference">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>. - </para> - <para> - <example> - <title><function>xml_set_object</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.13 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>xml_set_object</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>object</type><parameter role="reference">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>. + </para> + <para> + <example> + <title><function>xml_set_object</function> example</title> + <programlisting role="php"> <![CDATA[ <?php class xml { @@ -63,11 +62,11 @@ $xml_parser->parse("<A ID='hallo'>PHP</A>"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml?r1=1.5&r2=1.6&diff_format=u 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.5 phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml:1.5 Mon Aug 29 15:28:37 2005 +++ phpdoc/en/reference/xml/functions/xml-set-processing-instruction-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,90 +1,89 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <refentry id="function.xml-set-processing-instruction-handler"> - <refnamediv> - <refname>xml_set_processing_instruction_handler</refname> - <refpurpose> - Set up processing instruction (PI) handler - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>xml_set_processing_instruction_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</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>. - </para> - <para> - A processing instruction has the following format: - <informalexample> - <programlisting>&lt;?<replaceable>target</replaceable> - <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>?&gt;</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>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> - <para> - &true; is returned if the handler is set up, &false; if - <parameter>parser</parameter> is not a parser. - </para> - &note.func-callback; - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.xml-set-processing-instruction-handler"> + <refnamediv> + <refname>xml_set_processing_instruction_handler</refname> + <refpurpose> + Set up processing instruction (PI) handler + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>xml_set_processing_instruction_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</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>. + </para> + <para> + A processing instruction has the following format: + <informalexample> + <programlisting>&lt;?<replaceable>target</replaceable> + <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>?&gt;</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>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> + <para> + &true; is returned if the handler is set up, &false; if + <parameter>parser</parameter> is not a parser. + </para> + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml?r1=1.5&r2=1.6&diff_format=u 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.5 phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.5 Mon Mar 29 13:11:56 2004 +++ phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/xml.xml, last change in rev 1.24 --> - <refentry id='function.xml-set-start-namespace-decl-handler'> - <refnamediv> - <refname>xml_set_start_namespace_decl_handler</refname> - <refpurpose> - Set up start namespace declaration handler - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</type><parameter>handler</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - &note.func-callback; - </refsect1> - </refentry> +<refentry id='function.xml-set-start-namespace-decl-handler'> + <refnamediv> + <refname>xml_set_start_namespace_decl_handler</refname> + <refpurpose> + Set up start namespace declaration handler + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</type><parameter>handler</parameter></methodparam> + </methodsynopsis> + &warn.undocumented.func; + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml?r1=1.5&r2=1.6&diff_format=u 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.5 phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml:1.6 --- phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml:1.5 Fri Feb 28 06:45:12 2003 +++ phpdoc/en/reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml Mon Jan 8 02:22:13 2007 @@ -1,121 +1,121 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 --> - <refentry id="function.xml-set-unparsed-entity-decl-handler"> - <refnamediv> - <refname>xml_set_unparsed_entity_decl_handler</refname> - <refpurpose> - Set up unparsed entity declaration handler - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname> - <methodparam><type>resource</type><parameter>parser</parameter></methodparam> - <methodparam><type>callback</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> - <para> - This handler will be called if the XML parser encounters an - external entity declaration with an NDATA declaration, like the - following: - <programlisting role="xml"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.xml-set-unparsed-entity-decl-handler"> + <refnamediv> + <refname>xml_set_unparsed_entity_decl_handler</refname> + <refpurpose> + Set up unparsed entity declaration handler + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>callback</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> + <para> + This handler 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>} NDATA <parameter>notationName</parameter> ]]> - </programlisting> - </para> - <para> - See <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 of - 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: - <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> - <para> - &true; is returned if the handler is set up, &false; if - <parameter>parser</parameter> is not a parser. - </para> - &note.func-callback; - </refsect1> - </refentry> + </programlisting> + </para> + <para> + See <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 of + 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: + <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> + <para> + &true; is returned if the handler is set up, &false; if + <parameter>parser</parameter> is not a parser. + </para> + &note.func-callback; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: