File: domattr.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (172 lines) | stat: -rw-r--r-- 5,957 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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">
 <title>The <classname>DOMAttr</classname> class</title>
 <titleabbrev>DOMAttr</titleabbrev>
 
 <partintro>
 
<!-- {{{ DOMAttr intro -->
  <section xml:id="domattr.intro">
   &reftitle.intro;
   <para>
    <classname>DOMAttr</classname> represents an attribute in the 
    <classname>DOMElement</classname> object.
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="domattr.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>DOMAttr</classname>
    </ooclass>

    <ooclass>
     <modifier>extends</modifier>
     <classname>DOMNode</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&InheritedConstants;</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()='&Constants;']]))">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="domattr.props.name">name</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>bool</type>
     <varname linkend="domattr.props.specified">specified</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="domattr.props.value">value</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DOMElement</type><type>null</type></type>
     <varname linkend="domattr.props.ownerelement">ownerElement</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>mixed</type>
     <varname linkend="domattr.props.schematypeinfo">schemaTypeInfo</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.domattr')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DOMAttr'])">
     <xi:fallback/>
    </xi:include>
    <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'])">
     <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[@role='DOMNode'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->
 
  </section>
 
<!-- {{{ ClassName properties -->
  <section xml:id="domattr.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="domattr.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>The name of the attribute.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domattr.props.ownerelement">
     <term><varname>ownerElement</varname></term>
     <listitem>
      <para>The element which contains the attribute or &null;.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domattr.props.schematypeinfo">
     <term><varname>schemaTypeInfo</varname></term>
     <listitem>
      <para>Not implemented yet, always is &null;.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domattr.props.specified">
     <term><varname>specified</varname></term>
     <listitem>
      <para>Not implemented yet, always is &true;.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domattr.props.value">
     <term><varname>value</varname></term>
     <listitem>
      <para>The value of the attribute.</para>
      <note>
       <para>
        Note, XML entities are expanded upon setting a value.
        Thus the <literal>&amp;</literal> character has a special meaning.
        Setting <varname>value</varname> to itself will fail when <varname>value</varname> contains an <literal>&amp;</literal>.
        To avoid entity expansion, use <methodname>DOMElement::setAttribute</methodname> instead.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->
 
<!-- {{{ See also -->
  <section role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
     <member><link xlink:href="&url.spec.dom3.attr;">W3C specification of Attr</link></member>
    </simplelist>
   </para>
  </section>
<!-- }}} -->
 
 </partintro>
 
 &reference.dom.entities.domattr;
 
</reference>
<!-- 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
-->