archived-doc-ja/reference/xml/functions/xml-set-element-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-element-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_set_element_handler</refname>
  <refpurpose>開始要素および終了要素のハンドラを設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_element_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>start_handler</parameter></methodparam>
   <methodparam><type>callable</type><parameter>end_handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   XML パーサ <parameter>parser</parameter> の要素ハンドラ関数を設定します。
   <parameter>start_handler</parameter> および
   <parameter>end_handler</parameter> は、
   <function>xml_parse</function> が <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>start_handler</parameter></term>
     <listitem>
      <para>
       <parameter>start_handler</parameter> という名前の関数は、
       次の 3 つのパラメータをとる必要があります。
       <methodsynopsis>
        <methodname><replaceable>start_element_handler</replaceable></methodname>
        <methodparam><type>XMLParser</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>
           最初のパラメータである <replaceable>parser</replaceable> は、
           ハンドラをコールする XML パーサへのリファレンスです。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>name</parameter></term>
         <listitem>
          <simpara>
           2 番目のパラメータである <parameter>name</parameter> は、
           このハンドラがコールされた要素の名前を有しています。
           <link linkend="xml.case-folding">大文字変換</link>
           がこのパーサに関して有効な場合、要素の名前は大文字になります。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>attribs</parameter></term>
         <listitem>
          <simpara>
           第 3 のパラメータである <parameter>attribs</parameter> は、その要素の
           (全)属性に関する連想配列です。この配列のキーは属性の名前であり、
           値は属性の値です。属性の名前は、要素名と同様に <link
           linkend="xml.case-folding">大文字変換</link> となります。
           属性の値は、大文字変換 <emphasis>されません</emphasis>。
          </simpara>
          <simpara>
           この属性は、<function>each</function> を使用して
           <parameter>attribs</parameter> を順次アクセスすることにより、
           元の順序で取得することができます。
           配列の最初のキーが最初の属性であり、後も同様です。
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
      &note.func-callback;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>end_handler</parameter></term>
     <listitem>
      <para>
       <parameter>end_handler</parameter>という名前の関数は、
       2 つのパラメータをとる必要があります。
       <methodsynopsis>
        <methodname><replaceable>end_element_handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>name</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        <varlistentry>
         <term><parameter>parser</parameter></term> 
         <listitem>
          <simpara>
           最初のパラメータである <replaceable>parser</replaceable> は、
           ハンドラをコールする XML パーサへのリファレンスです。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>name</parameter></term>
         <listitem>
          <simpara>
           2 番目のパラメータである <parameter>name</parameter> は、
           このハンドラがコールされた要素の名前を有しています。このパーサにおいて
           <link linkend="xml.case-folding">大文字変換</link> 
           が有効な場合、要素名は大文字になります。
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
      <para>
       ハンドラ関数が空の文字列または &false; に設定されている場合、そのハンドラは無効です。
      </para>
     </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
-->