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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3db49ee0a331a657dd97b539a749f53d3965b593 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<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>XMLParser</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> は、
       <parameter>parser</parameter> に関して <function>xml_parse</function> 
       がコールされた際に必要な関数の名前を有する文字列です。
      </para>
      <para>
       <parameter>handler</parameter> という名前の関数は 5 つのパラメータをとり、
       整数値を返す必要があります。ハンドラから返された値が &false; の場合
       (これは値が返されない場合に相当します)、XML パーサは処理を中断し、
       <function>xml_get_error_code</function> は
       <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>
       を返します。
       <methodsynopsis>
        <methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>XMLParser</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>
           2 番目のパラメータ、<parameter>open_entity_names</parameter> は、
           エンティティの処理を行うためにオープンされたエンティティの
           名前のスペース区切りのリストです
           (参照されるエンティティの名前を含みます)。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>base</parameter></term>
         <listitem>
          <simpara>
           これは外部エンティティのシステム
           ID (<parameter>systemid</parameter>) を有しています。
           現在このパラメータは常に空の文字列に設定されています。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           4 番目のパラメータ、<parameter>systemId</parameter> は
           エンティティ宣言で指定されたシステム ID です。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara>
           5 番目のパラメータ <parameter>publicId</parameter> は、エンティティ宣言で
           指定されたパブリック ID または指定されない場合は空の
           文字列です。パブリック ID の中の空白文字は、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>
      &xml.changelog.parser-param;
     <row>
      <entry>7.3.0</entry>
      <entry>
       拡張モジュールが libxml を使ってビルドされた場合には、コールバック
       <parameter>handler</parameter>
       の戻り値が無視されることはなくなりました。
       このバージョン以前はコールバックの戻り値が無視され、パースが止まりませんでした。 
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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>
       拡張モジュールが libxml を使ってビルドされていた場合、
       <parameter>handler</parameter> の戻り値は無視されることはなくなりました。
       これより前のバージョンでは、戻り値が無視されていた上、パースが止まりませんでした。
      </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
-->