archived-doc-ja/reference/xml/functions/xml-set-notation-decl-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 18aa2012f6fa1e5b09733147e02911d16e06d4a1 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa -->
<refentry xml:id="function.xml-set-notation-decl-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>xml_set_notation_decl_handler</refname>
  <refpurpose>表記法宣言ハンドラを設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>xml_set_notation_decl_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type class="union"><type>callable</type><type>string</type><type>null</type></type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   XML パーサー <parameter>parser</parameter> の表記法宣言用ハンドラ関数を設定します。
  </para>
  <para>
   表記法の宣言は、ドキュメントの DTD の一部であり、
   次のようなフォーマットとなります。
   <programlisting role="xml">
<![CDATA[
<!NOTATION <parameter>name</parameter>
{ <parameter>systemId</parameter> | <parameter>publicId</parameter>?>
]]>
   </programlisting>
   表記法宣言の定義に関しては、
   <link xlink:href="&url.rec-xml;#Notations">XML 1.0 仕様の 4.7 節</link> 
   を参照ください。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &xml.parser.param;
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      &xml.handler.description;
      <para>
       ハンドラのシグネチャは、以下でなければいけません:
       <methodsynopsis>
        <type>void</type><methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
        <methodparam><type class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
        <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
        <methodparam><type class="union"><type>string</type><type>false</type></type><parameter>public_id</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        &xml.handler.parser.param;
        <varlistentry>
         <term><parameter>notation_name</parameter></term>
         <listitem>
          <simpara>
           これは、前述の表記用フォーマットに示すように表記法の名前です。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <parameter>base</parameter>
         </term>
         <listitem>
          <simpara>
           外部エンティティのシステムID(<literal>system_id</literal>)を
           取得する際の基本となります。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           外部表記用宣言のシステム ID
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <parameter>public_id</parameter>
         </term>
         <listitem>
          <simpara>
           外部表記用宣言のパブリック ID
          </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
-->