archived-doc-ru/reference/xml/functions/xml-set-external-entity-ref-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c90b300562d957c981eb1dacacd3f6716348fd67 Maintainer: tmn Status: ready -->
<!-- Reviewed: yes -->
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.xml-set-external-entity-ref-handler">
 <refnamediv>
  <refname>xml_set_external_entity_ref_handler</refname>
  <refpurpose>Установка обработчика внешних сущностей</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_external_entity_ref_handler</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Задает функцию обработчик внешних сущностей для XML-анализатора
   <parameter>parser</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       Ссылка на XML-анализатор.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      <para>
       <parameter>handler</parameter> - строка содержащая имя функции, которая 
       должна быть определена на момент вызова функции
       <function>xml_parse</function> из анализатора 
       <parameter>parser</parameter>.
      </para>
      <para>
       Функция с именем <parameter>handler</parameter> должна принимать
       пять аргументов и возвращать целочисленный результат. Если обработчик 
       вернет &false; (равно как и ничего не вернет), XML анализатор прекратит
       работу, а функция <function>xml_get_error_code</function> будет 
       возвращать константу
       <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>. 
       <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>
           Первый аргумент <replaceable>parser</replaceable> является ссылкой
           на XML-анализатор вызывающий обработчик.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>open_entity_names</parameter></term>
         <listitem>
          <simpara>
           Второй аргумент <parameter>open_entity_names</parameter> - список
           разделенных пробелами имен сущностей, которые могут участвовать
           в разборе текущей сущности (включая текущую сущность).
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>base</parameter></term>
         <listitem>
          <simpara>
           Это основа для разрешения системного идентификатора
           (<parameter>system_id</parameter>) внешней сущности. На данный момент
           в качестве этого аргумента всегда передается пустая строка.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           Четвертый аргумент <parameter>system_id</parameter> - системный 
           идентификатор в том виде, как он представлен в объявлении сущности.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara>
           Пятый аргумент <parameter>public_id</parameter> - общедоступный 
           идентификатор в том виде, как он представлен в объявлении сущности,
           либо пустая строка, если такового нет; пробелы в идентификаторе 
           будут нормализованы в соответствии с требованиями XML-спецификации.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
      <para>
       Если в качестве обработчика передана пустая строка или &false;, этот
       обработчик отключается.
      </para>
      &note.func-callback;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.3.0</entry>
      <entry>
       Возвращаемое значение <parameter>handler</parameter> теперь также
       учитывается, если расширение не собрано с библиотекой libxml.
       Раньше возвращаемое значение игнорировалось, а разбор
       никогда не останавливался.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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:"~/.phpdoc/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
-->