Skip to content

Commit d88318e

Browse files
committed
DOMNode::compareDocumentPosition、DOMNode::DOCUMENT_の英文を追加
1 parent 444499c commit d88318e

File tree

2 files changed

+205
-0
lines changed

2 files changed

+205
-0
lines changed

reference/dom/domnode.xml

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,50 @@
2525
<classname>DOMNode</classname>
2626
</ooclass>
2727

28+
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
29+
<fieldsynopsis>
30+
<modifier>public</modifier>
31+
<modifier>const</modifier>
32+
<type>int</type>
33+
<varname linkend="domnode.constants.document-position-disconnected">DOMNode::DOCUMENT_POSITION_DISCONNECTED</varname>
34+
<initializer>1</initializer>
35+
</fieldsynopsis>
36+
<fieldsynopsis>
37+
<modifier>public</modifier>
38+
<modifier>const</modifier>
39+
<type>int</type>
40+
<varname linkend="domnode.constants.document-position-preceding">DOMNode::DOCUMENT_POSITION_PRECEDING</varname>
41+
<initializer>2</initializer>
42+
</fieldsynopsis>
43+
<fieldsynopsis>
44+
<modifier>public</modifier>
45+
<modifier>const</modifier>
46+
<type>int</type>
47+
<varname linkend="domnode.constants.document-position-following">DOMNode::DOCUMENT_POSITION_FOLLOWING</varname>
48+
<initializer>4</initializer>
49+
</fieldsynopsis>
50+
<fieldsynopsis>
51+
<modifier>public</modifier>
52+
<modifier>const</modifier>
53+
<type>int</type>
54+
<varname linkend="domnode.constants.document-position-contains">DOMNode::DOCUMENT_POSITION_CONTAINS</varname>
55+
<initializer>8</initializer>
56+
</fieldsynopsis>
57+
<fieldsynopsis>
58+
<modifier>public</modifier>
59+
<modifier>const</modifier>
60+
<type>int</type>
61+
<varname linkend="domnode.constants.document-position-contained-by">DOMNode::DOCUMENT_POSITION_CONTAINED_BY</varname>
62+
<initializer>16</initializer>
63+
</fieldsynopsis>
64+
<fieldsynopsis>
65+
<modifier>public</modifier>
66+
<modifier>const</modifier>
67+
<type>int</type>
68+
<varname linkend="domnode.constants.document-position-implementation-specific">DOMNode::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC</varname>
69+
<initializer>32</initializer>
70+
</fieldsynopsis>
71+
2872
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
2973
<fieldsynopsis>
3074
<modifier>public</modifier>
@@ -140,6 +184,74 @@
140184
<!-- }}} -->
141185

142186
</section>
187+
188+
<section xml:id="domnode.constants">
189+
&reftitle.constants;
190+
<variablelist>
191+
<varlistentry xml:id="domnode.constants.document-position-disconnected">
192+
<term>
193+
<constant>DOMNode::DOCUMENT_POSITION_DISCONNECTED</constant>
194+
</term>
195+
<listitem>
196+
<simpara>
197+
Set when the other node and reference node are not in the same tree.
198+
</simpara>
199+
</listitem>
200+
</varlistentry>
201+
<varlistentry xml:id="domnode.constants.document-position-preceding">
202+
<term>
203+
<constant>DOMNode::DOCUMENT_POSITION_PRECEDING</constant>
204+
</term>
205+
<listitem>
206+
<simpara>
207+
Set when the other node precedes the reference node.
208+
</simpara>
209+
</listitem>
210+
</varlistentry>
211+
<varlistentry xml:id="domnode.constants.document-position-following">
212+
<term>
213+
<constant>DOMNode::DOCUMENT_POSITION_FOLLOWING</constant>
214+
</term>
215+
<listitem>
216+
<simpara>
217+
Set when the other node follows the reference node.
218+
</simpara>
219+
</listitem>
220+
</varlistentry>
221+
<varlistentry xml:id="domnode.constants.document-position-contains">
222+
<term>
223+
<constant>DOMNode::DOCUMENT_POSITION_CONTAINS</constant>
224+
</term>
225+
<listitem>
226+
<simpara>
227+
Set when the other node is an ancestor of the reference node.
228+
</simpara>
229+
</listitem>
230+
</varlistentry>
231+
<varlistentry xml:id="domnode.constants.document-position-contained-by">
232+
<term>
233+
<constant>DOMNode::DOCUMENT_POSITION_CONTAINED_BY</constant>
234+
</term>
235+
<listitem>
236+
<simpara>
237+
Set when the other node is a descendant of the reference node.
238+
</simpara>
239+
</listitem>
240+
</varlistentry>
241+
<varlistentry xml:id="domnode.constants.document-position-implementation-specific">
242+
<term>
243+
<constant>DOMNode::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC</constant>
244+
</term>
245+
<listitem>
246+
<simpara>
247+
Set when the result depends on implementation-specific behaviour and
248+
may not be portable.
249+
This may happen with disconnected nodes or with attribute nodes.
250+
</simpara>
251+
</listitem>
252+
</varlistentry>
253+
</variablelist>
254+
</section>
143255

144256
<!-- {{{ DOMNode properties -->
145257
<section xml:id="domnode.props">
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="domnode.comparedocumentposition" xmlns="http://docbook.org/ns/docbook">
3+
<refnamediv>
4+
<refname>DOMNode::compareDocumentPosition</refname>
5+
<refpurpose>Compares the position of two nodes</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="DOMNode">
11+
<modifier>public</modifier> <type>int</type><methodname>DOMNode::compareDocumentPosition</methodname>
12+
<methodparam><type>DOMNode</type><parameter>other</parameter></methodparam>
13+
</methodsynopsis>
14+
<simpara>
15+
Compares the position of the other node relative to this node.
16+
</simpara>
17+
</refsect1>
18+
19+
<refsect1 role="parameters">
20+
&reftitle.parameters;
21+
<variablelist>
22+
<varlistentry>
23+
<term><parameter>other</parameter></term>
24+
<listitem>
25+
<para>
26+
The node for which the position should be compared for, relative to this node.
27+
</para>
28+
</listitem>
29+
</varlistentry>
30+
</variablelist>
31+
</refsect1>
32+
33+
<refsect1 role="returnvalues">
34+
&reftitle.returnvalues;
35+
<simpara>
36+
A bitmask of the <constant>DOMNode::DOCUMENT_POSITION_<replaceable>*</replaceable></constant>
37+
constants.
38+
</simpara>
39+
</refsect1>
40+
41+
<refsect1 role="examples">
42+
&reftitle.examples;
43+
<example>
44+
<title><methodname>DOMNode::compareDocumentPosition</methodname> example</title>
45+
<programlisting role="php">
46+
<![CDATA[
47+
<?php
48+
$xml = <<<XML
49+
<root>
50+
<child1/>
51+
<child2/>
52+
</root>
53+
XML;
54+
$dom = new DOMDocument();
55+
$dom->loadXML($xml);
56+
$root = $dom->documentElement;
57+
$child1 = $root->firstElementChild;
58+
$child2 = $child1->nextElementSibling;
59+
var_dump($root->compareDocumentPosition($child1));
60+
var_dump($child2->compareDocumentPosition($child1));
61+
?>
62+
]]>
63+
</programlisting>
64+
&example.outputs;
65+
<screen>
66+
<![CDATA[
67+
int(20) // This is DOMNode::DOCUMENT_POSITION_CONTAINED_BY | DOMNode::DOCUMENT_POSITION_FOLLOWING
68+
int(2) // This is DOMNode::DOCUMENT_POSITION_PRECEDING
69+
]]>
70+
</screen>
71+
</example>
72+
</refsect1>
73+
</refentry>
74+
<!-- Keep this comment at the end of the file
75+
Local variables:
76+
mode: sgml
77+
sgml-omittag:t
78+
sgml-shorttag:t
79+
sgml-minimize-attributes:nil
80+
sgml-always-quote-attributes:t
81+
sgml-indent-step:1
82+
sgml-indent-data:t
83+
indent-tabs-mode:nil
84+
sgml-parent-document:nil
85+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
86+
sgml-exposed-tags:nil
87+
sgml-local-catalogs:nil
88+
sgml-local-ecat-files:nil
89+
End:
90+
vim600: syn=xml fen fdm=syntax fdl=2 si
91+
vim: et tw=78 syn=sgml
92+
vi: ts=1 sw=1
93+
-->

0 commit comments

Comments
 (0)