mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 15:12:22 +01:00
Closes #310 Co-authored-by: KentarouTakeda <4785040+KentarouTakeda@users.noreply.github.com>
152 lines
5.3 KiB
XML
152 lines
5.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 18aa2012f6fa1e5b09733147e02911d16e06d4a1 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>true</type><methodname>xml_set_external_entity_ref_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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&xml.parser.param;
|
|
<varlistentry>
|
|
<term><parameter>handler</parameter></term>
|
|
<listitem>
|
|
&xml.handler.description;
|
|
<para>
|
|
<parameter>handler</parameter> のシグネチャは、以下でなければいけません:
|
|
<methodsynopsis>
|
|
<type>bool</type><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 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>open_entity_names</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
エンティティの処理を行うためにオープンされたエンティティの
|
|
名前のスペース区切りのリストです
|
|
(参照されるエンティティの名前を含みます)。
|
|
</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>
|
|
エンティティ宣言で指定されたシステム ID です。
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>public_id</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
エンティティ宣言で
|
|
指定されたパブリック ID または指定されない場合は空の
|
|
文字列です。パブリック ID の中の空白文字は、XML 仕様で規定された
|
|
正規化を行っています。
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
ハンドラは、エンティティを処理された場合、&true; を返す必要があります。
|
|
そうでない場合、&false; を返すべきです。
|
|
ハンドラから返された値が &false; の場合、XML パーサーは処理を中断し、
|
|
<function>xml_get_error_code</function> は
|
|
<constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>
|
|
を返します。
|
|
</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;
|
|
<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
|
|
-->
|