archived-doc-ja/reference/xml/functions/xml-set-processing-instruction-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3db49ee0a331a657dd97b539a749f53d3965b593 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<refentry xml:id="function.xml-set-processing-instruction-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_set_processing_instruction_handler</refname>
  <refpurpose>
   処理命令 (PI) 用ハンドラを設定する
  </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_processing_instruction_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   XML パーサ <parameter>parser</parameter>の処理命令 (PI) 用ハンドラ関数を設定します。
  </para>
  <para>
   処理命令は、次のフォーマットを有しています。
   <informalexample>
    <programlisting>&lt;?<replaceable>target</replaceable> 
     <replaceable>data</replaceable>?&gt;
    </programlisting>
   </informalexample>
   このようなタグに PHP コードを入れることが可能ですが、一つの制約に
   注意してください。XML PI において、PI 終了タグ
   (<literal>?&gt;</literal>)は引用符で括ることができません。
   このため、この文字の並びを XML ドキュメント中にPIにより埋め込んだ
   PHP コードの中で使用することはできません。これを使用した場合、残りの
   PHP コードは、"真の" PI 終了タグと同じく文字データとして処理
   されます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       処理命令 (PI) ハンドラ関数を設定する 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> という名前の関数は、
       次の 3 つのパラメータを引数とする必要があります。
       <methodsynopsis>
        <methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>XMLParser</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>
           最初のパラメータ、<replaceable>parser</replaceable> は
           ハンドラをコールする XML パーサへのリファレンスです。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>target</parameter></term>
         <listitem>
          <simpara>
           第 2 のパラメータ、<parameter>target</parameter> は
           PI のターゲットを有しています。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>data</parameter></term>
         <listitem>
          <simpara>
           第 3 のパラメータ、<parameter>data</parameter> は、
           PI のデータを有しています。
          </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;
    </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
-->