mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
0deb79ee81
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@241480 c90b9560-bf6c-de11-be94-00142212c4b1
114 lines
3.3 KiB
XML
114 lines
3.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.xml-set-character-data-handler">
|
|
<refnamediv>
|
|
<refname>xml_set_character_data_handler</refname>
|
|
<refpurpose>Set up character data handler</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parser</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>handler</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>handler</parameter> is a string containing the name of a
|
|
function that must exist when <function>xml_parse</function> is called
|
|
for <parameter>parser</parameter>.
|
|
</para>
|
|
<para>
|
|
The function named by <parameter>handler</parameter> must accept
|
|
two parameters:
|
|
<methodsynopsis>
|
|
<methodname><replaceable>handler</replaceable></methodname>
|
|
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parser</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The first parameter, <replaceable>parser</replaceable>, is a
|
|
reference to the XML parser calling the handler.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The second parameter, <parameter>data</parameter>, contains
|
|
the character data as a string.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
Character data handler is called for every piece of a text in the XML
|
|
document. It can be called multiple times inside each fragment (e.g.
|
|
for non-ASCII strings).
|
|
</para>
|
|
<para>
|
|
If a handler function is set to an empty string, or &false;, the handler
|
|
in question is disabled.
|
|
</para>
|
|
¬e.func-callback;
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|