xml-set-element-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9cd8eb0f11edb4e59fd22f723137bbb91d6ab64f 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>true</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> の要素ハンドラ関数を設定します。
  </para>
  <para>
   <parameter>start_handler</parameter> は、新しいXML要素が開始された場合にコールされます。<parameter>end_handler</parameter> は、XML要素が終了した場合にコールされます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &xml.parser.param;
    <varlistentry>
     <term><parameter>start_handler</parameter></term>
     <listitem>
      &xml.handler.description;
      <para>
       シグネチャは、以下でなければいけません:
       <methodsynopsis>
        <type>void</type><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>attributes</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        &xml.handler.parser.param;
        <varlistentry>
         <term><parameter>name</parameter></term>
         <listitem>
          <simpara>
           このハンドラがコールされた要素の名前です。
           <link linkend="xml.case-folding">大文字変換</link>
           がこのパーサに関して有効な場合、要素の名前は大文字になります。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>attributes</parameter></term>
         <listitem>
          <simpara>
           要素の属性に関する連想配列です。
           要素に属性がない場合、配列は空になります。
           この配列のキーは属性の名前であり、
           値は属性の値です。属性の名前は、要素名と同様に <link
           linkend="xml.case-folding">大文字変換</link> となります。
           属性の値は、大文字変換 <emphasis>されません</emphasis>。
          </simpara>
          <simpara>
           <parameter>attributes</parameter> を順次アクセスすることにより、
           属性を宣言した元の順序で取得することができます。
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>end_handler</parameter></term>
     <listitem>
      &xml.handler.description;
      <para>
       ハンドラのシグネチャは、以下でなければいけません:
       <methodsynopsis>
        <type>void</type><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>
        &xml.handler.parser.param;
        <varlistentry>
         <term><parameter>name</parameter></term>
         <listitem>
          <simpara>
           このハンドラがコールされた要素の名前です。
           このパーサにおいて
           <link linkend="xml.case-folding">大文字変換</link> 
           が有効な場合、要素名は大文字になります。
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &xml.changelog.handler-param;
     &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
-->