reference/dom/domattr.xml
f80105b4fc1196bd8d5fecb98d686b580b1ff65d
...
...
@@ -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
+
<phpdoc:classref xml:id="class.domattr" 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">
4
4
<title>The <classname>DOMAttr</classname> class</title>
5
5
<titleabbrev>DOMAttr</titleabbrev>
6
6
...
...
@@ -20,26 +20,17 @@
20
20
&reftitle.classsynopsis;
21
21
22
22
<!-- {{{ Synopsis -->
23
-
<classsynopsis>
24
-
<ooclass><classname>DOMAttr</classname></ooclass>
23
+
<classsynopsis class="class">
24
+
<ooclass>
25
+
<classname>DOMAttr</classname>
26
+
</ooclass>
25
27

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
-
<!-- }}} -->
28
+
<ooclass>
29
+
<modifier>extends</modifier>
30
+
<classname>DOMNode</classname>
31
+
</ooclass>
40
32

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

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

73
71
<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])" />
72
+
<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'])">
73
+
<xi:fallback/>
74
+
</xi:include>
75
+
<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'])">
76
+
<xi:fallback/>
77
+
</xi:include>
75
78

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

161
170