reference/dom/domattr.xml
d75a54118772b34c7a538962ac5f994900c99690
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.domattr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
3
+
<reference xml:id="class.domattr" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
4
4
<title>The <classname>DOMAttr</classname> class</title>
5
5
<titleabbrev>DOMAttr</titleabbrev>
6
6
...
...
@@ -20,26 +20,22 @@
20
20
&reftitle.classsynopsis;
21
21
22
22
<!-- {{{ Synopsis -->
23
-
<classsynopsis>
24
-
<ooclass><classname>DOMAttr</classname></ooclass>
25
-
26
-
<!-- {{{ Class synopsis -->
27
-
<classsynopsisinfo>
28
-
<ooclass>
29
-
<classname>DOMAttr</classname>
30
-
</ooclass>
31
-
32
-
<!-- If the class extends another one, use this -->
33
-
<ooclass>
34
-
<modifier>extends</modifier>
35
-
<classname>DOMNode</classname>
36
-
</ooclass>
37
-
38
-
</classsynopsisinfo>
39
-
<!-- }}} -->
23
+
<classsynopsis class="class">
24
+
<ooclass>
25
+
<classname>DOMAttr</classname>
26
+
</ooclass>
27
+

28
+
<ooclass>
29
+
<modifier>extends</modifier>
30
+
<classname>DOMNode</classname>
31
+
</ooclass>
32
+

33
+
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
34
+
<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()='&Constants;']]))">
35
+
<xi:fallback/>
36
+
</xi:include>
40
37

41
38
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
42
-
<!-- If the property is documented below (xml:id=classname.props) use this -->
43
39
<fieldsynopsis>
44
40
<modifier>public</modifier>
45
41
<modifier>readonly</modifier>
...
...
@@ -49,34 +45,44 @@
49
45
<fieldsynopsis>
50
46
<modifier>public</modifier>
51
47
<modifier>readonly</modifier>
52
-
<type>DOMElement</type>
53
-
<varname linkend="domattr.props.ownerelement">ownerElement</varname>
48
+
<type>bool</type>
49
+
<varname linkend="domattr.props.specified">specified</varname>
54
50
</fieldsynopsis>
55
51
<fieldsynopsis>
56
52
<modifier>public</modifier>
57
-
<modifier>readonly</modifier>
58
-
<type>bool</type>
59
-
<varname linkend="domattr.props.schematypeinfo">schemaTypeInfo</varname>
53
+
<type>string</type>
54
+
<varname linkend="domattr.props.value">value</varname>
60
55
</fieldsynopsis>
61
56
<fieldsynopsis>
62
57
<modifier>public</modifier>
63
58
<modifier>readonly</modifier>
64
-
<type>bool</type>
65
-
<varname linkend="domattr.props.specified">specified</varname>
59
+
<type class="union"><type>DOMElement</type><type>null</type></type>
60
+
<varname linkend="domattr.props.ownerelement">ownerElement</varname>
66
61
</fieldsynopsis>
67
62
<fieldsynopsis>
68
63
<modifier>public</modifier>
69
-
<type>string</type>
70
-
<varname linkend="domattr.props.value">value</varname>
64
+
<modifier>readonly</modifier>
65
+
<type>mixed</type>
66
+
<varname linkend="domattr.props.schematypeinfo">schemaTypeInfo</varname>
71
67
</fieldsynopsis>
72
68

69
+
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
70
+
<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;']]))">
71
+
<xi:fallback/>
72
+
</xi:include>
73
+

73
74
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
74
-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domattr')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
75
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domattr')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DOMAttr'])">
76
+
<xi:fallback/>
77
+
</xi:include>
78
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domattr')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DOMAttr'])">
79
+
<xi:fallback/>
80
+
</xi:include>
75
81

76
-
<!-- Again, if the class extends a class use this -->
77
82
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
78
-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
79
-
83
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DOMNode'])">
84
+
<xi:fallback/>
85
+
</xi:include>
80
86
</classsynopsis>
81
87
<!-- }}} -->
82
88
...
...
@@ -89,31 +95,39 @@
89
95
<varlistentry xml:id="domattr.props.name">
90
96
<term><varname>name</varname></term>
91
97
<listitem>
92
-
<para>The name of the attribute</para>
98
+
<para>The name of the attribute.</para>
93
99
</listitem>
94
100
</varlistentry>
95
101
<varlistentry xml:id="domattr.props.ownerelement">
96
102
<term><varname>ownerElement</varname></term>
97
103
<listitem>
98
-
<para>The element which contains the attribute</para>
104
+
<para>The element which contains the attribute or &null;.</para>
99
105
</listitem>
100
106
</varlistentry>
101
107
<varlistentry xml:id="domattr.props.schematypeinfo">
102
108
<term><varname>schemaTypeInfo</varname></term>
103
109
<listitem>
104
-
<para>Not implemented yet, always is &null;</para>
110
+
<para>Not implemented yet, always is &null;.</para>
105
111
</listitem>
106
112
</varlistentry>
107
113
<varlistentry xml:id="domattr.props.specified">
108
114
<term><varname>specified</varname></term>
109
115
<listitem>
110
-
<para>Not implemented yet, always is &null;</para>
116
+
<para>Not implemented yet, always is &true;.</para>
111
117
</listitem>
112
118
</varlistentry>
113
119
<varlistentry xml:id="domattr.props.value">
114
120
<term><varname>value</varname></term>
115
121
<listitem>
116
-
<para>The value of the attribute</para>
122
+
<para>The value of the attribute.</para>
123
+
<note>
124
+
<para>
125
+
Note, XML entities are expanded upon setting a value.
126
+
Thus the <literal>&amp;</literal> character has a special meaning.
127
+
Setting <varname>value</varname> to itself will fail when <varname>value</varname> contains an <literal>&amp;</literal>.
128
+
To avoid entity expansion, use <methodname>DOMElement::setAttribute</methodname> instead.
129
+
</para>
130
+
</note>
117
131
</listitem>
118
132
</varlistentry>
119
133
</variablelist>
...
...
@@ -135,8 +149,7 @@
135
149
136
150
&reference.dom.entities.domattr;
137
151
138
-
</phpdoc:classref>
139
-
152
+
</reference>
140
153
<!-- Keep this comment at the end of the file
141
154
Local variables:
142
155
mode: sgml
...
...
@@ -157,4 +170,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
157
170
vim: et tw=78 syn=sgml
158
171
vi: ts=1 sw=1
159
172
-->
160
-

161
173



Translation status