php/archived-doc-ja
1
0
Fork 0
mirror of https://github.com/php/doc-ja.git synced 2026-03-29 18:42:19 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
052d47f51a9ab70f1cc94eec8819869f336c2b5d
archived-doc-ja/reference/dom/domdocument.xml
Yoshinari Takaoka c5cc00c283 Reorder DOMDocument properties 
6d48923b82
2022-04-21 19:39:11 +09:00

470 lines
17 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6d48923b82b3b517f2f46fa44eea9aa35264fe60 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<phpdoc:classref xml:id="class.domdocument" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>DOMDocument クラス</title>
<titleabbrev>DOMDocument</titleabbrev>
<partintro>
<!-- {{{ DOMDocument intro -->
<section xml:id="domdocument.intro">
&reftitle.intro;
<para>
HTML ドキュメントあるいは XML ドキュメント全体を表し、
ドキュメントツリーのルートとなります。
</para>
</section>
<!-- }}} -->
<section xml:id="domdocument.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>DOMDocument</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>DOMDocument</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
<oointerface>
<interfacename>DOMParentNode</interfacename>
</oointerface>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>DOMDocumentType</type><type>null</type></type>
<varname linkend="domdocument.props.doctype">doctype</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMImplementation</type>
<varname linkend="domdocument.props.implementation">implementation</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>DOMElement</type><type>null</type></type>
<varname linkend="domdocument.props.documentelement">documentElement</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="domdocument.props.actualencoding">actualEncoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="domdocument.props.encoding">encoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="domdocument.props.xmlencoding">xmlEncoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.standalone">standalone</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.xmlstandalone">xmlStandalone</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="domdocument.props.version">version</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="domdocument.props.xmlversion">xmlVersion</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.stricterrorchecking">strictErrorChecking</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="domdocument.props.documenturi">documentURI</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>mixed</type>
<varname linkend="domdocument.props.config">config</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.formatoutput">formatOutput</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.validateonparse">validateOnParse</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.resolveexternals">resolveExternals</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.preservewhitespace">preserveWhiteSpace</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.recover">recover</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.substituteentities">substituteEntities</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>DOMElement</type><type>null</type></type>
<varname linkend="domdocument.props.firstelementchild">firstElementChild</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>DOMElement</type><type>null</type></type>
<varname linkend="domdocument.props.lastelementchild">lastElementChild</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="domdocument.props.childelementcount">childElementCount</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
<xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMDocument properties -->
<section xml:id="domdocument.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domdocument.props.actualencoding">
<term><varname>actualEncoding</varname></term>
<listitem>
<para>
<emphasis>非推奨</emphasis>。ドキュメントの実際のエンコーディング。
読み込み専用で、
<varname linkend="domdocument.props.encoding">encoding</varname>
と同等の内容です。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.childelementcount">
<term><varname>childElementCount</varname></term>
<listitem>
<para>子要素の数</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.config">
<term><varname>config</varname></term>
<listitem>
<para>
<emphasis>非推奨</emphasis>。
<function>DOMDocument::normalizeDocument</function>
を実行する際に使用する設定。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.doctype">
<term><varname>doctype</varname></term>
<listitem>
<para>このドキュメントに関連付けられた文書型宣言</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.documentelement">
<term><varname>documentElement</varname></term>
<listitem>
<para>
最初のドキュメント要素を示す <classname>DOMElement</classname> オブジェクト。
存在しない場合は &null; になります。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.documenturi">
<term><varname>documentURI</varname></term>
<listitem>
<para>ドキュメントの位置。未定義の場合は &null;</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.encoding">
<term><varname>encoding</varname></term>
<listitem>
<para>
XML 宣言で指定したドキュメントのエンコーディング。
この属性は、DOM Level 3 の最終的な仕様には存在しません。
しかし、この実装で XML ドキュメントのエンコーディングを扱うにはこれを使用するしかありません。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.firstelementchild">
<term><varname>firstElementChild</varname></term>
<listitem>
<para>最初の子要素。存在しない場合は &null; になります。</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.formatoutput">
<term><varname>formatOutput</varname></term>
<listitem>
<para>
字下げや空白を考慮してきれいに整形した出力を行う。
これは、ドキュメントを
<varname linkend="domdocument.props.preservewhitespace">preserveWhitespace</varname>
を有効にして読み込んだ場合は効果がありません。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.implementation">
<term><varname>implementation</varname></term>
<listitem>
<para>
このドキュメントを処理する
<classname>DOMImplementation</classname> オブジェクト
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.lastelementchild">
<term><varname>lastElementChild</varname></term>
<listitem>
<para>最後の子要素。存在しない場合は &null; になります。</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.preservewhitespace">
<term><varname>preserveWhiteSpace</varname></term>
<listitem>
<para>
余分な空白を取り除かない。デフォルトは &true;
&false; に設定すると、
<methodname>DOMDocument::load</methodname> の <parameter>option</parameter>
に <constant>LIBXML_NOBLANKS</constant> を渡すのと同じ効果があります。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.recover">
<term><varname>recover</varname></term>
<listitem>
<para>
<emphasis>非標準</emphasis>。
リカバリーモードを有効にし、整形式でないドキュメントのパースを試みます。
この属性は DOM の仕様にはなく、libxml 固有の独自仕様です。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.resolveexternals">
<term><varname>resolveExternals</varname></term>
<listitem>
<para>
文書型宣言で外部エンティティを読み込む際に &true; を設定する。
XML ドキュメントに文字エンティティを含める際に便利です。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.standalone">
<term><varname>standalone</varname></term>
<listitem>
<para>
<emphasis>非推奨</emphasis>。
そのドキュメントがスタンドアローンかどうかを XML 宣言で指定したもの。
<varname linkend="domdocument.props.xmlstandalone">xmlStandalone</varname>
に対応します。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.stricterrorchecking">
<term><varname>strictErrorChecking</varname></term>
<listitem>
<para>エラー時に <classname>DOMException</classname> をスローする。デフォルトは &true;</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.substituteentities">
<term><varname>substituteEntities</varname></term>
<listitem>
<para>
<emphasis>非標準</emphasis>。
エンティティの置換を行うかどうか。
この属性は DOM の仕様にはなく、libxml 固有の独自仕様です。
</para>
<caution>
<simpara>
エンティティの置換を有効にすると、XML外部エンティティ参照攻撃(XXE) を容易にしてしまうかもしれません。
</simpara>
</caution>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.validateonparse">
<term><varname>validateOnParse</varname></term>
<listitem>
<para>DTD を読み込んで検証する。デフォルトは &false;</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.version">
<term><varname>version</varname></term>
<listitem>
<para>
<emphasis>非推奨</emphasis>。
XML のバージョン。
<varname linkend="domdocument.props.xmlversion">xmlVersion</varname>
に対応します。
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.xmlencoding">
<term><varname>xmlEncoding</varname></term>
<listitem>
<para>
XML 宣言の一部として、このドキュメントのエンコーディングを
指定する属性。指定されていない場合や不明な場合 (たとえば
ドキュメントがメモリ上に存在する場合など) は &null;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.xmlstandalone">
<term><varname>xmlStandalone</varname></term>
<listitem>
<para>
XML 宣言の一部として、このドキュメントがスタンドアローンか
どうかを指定する。指定されていない場合は &false;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.xmlversion">
<term><varname>xmlVersion</varname></term>
<listitem>
<para>
XML 宣言の一部として、このドキュメントのバージョン番号を指定する。
バージョン番号が定義されておらず、ドキュメントが "XML" の機能を
サポートしている場合は、値は "1.0"
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<classname>DOMDocument</classname> は、
<interfacename>DOMParentNode</interfacename> を実装しました。
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
実装されていなかったメソッド
<methodname>DOMDocument::renameNode</methodname>
が削除されました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<!-- {{{ Notes -->
<section role="notes">
&reftitle.notes;
&dom.note.utf8;
&dom.note.json;
</section>
<!-- }}} -->
<!-- {{{ See also -->
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&url.spec.dom3.document;">W3C specification for Document</link></member>
</simplelist>
</para>
</section>
<!-- }}} -->
</partintro>
&reference.dom.entities.domdocument;
</phpdoc:classref>
<!-- 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
-->
Reference in New Issue View Git Blame Copy Permalink