File: XMLReader.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (384 lines) | stat: -rw-r--r-- 13,595 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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="XMLReader" namespace="" name="XMLReader">
  <constant name="NONE" value="0">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="ELEMENT" value="1">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="ATTRIBUTE" value="2">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="TEXT" value="3">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="CDATA" value="4">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="ENTITY_REF" value="5">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="ENTITY" value="6">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="PI" value="7">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="COMMENT" value="8">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="DOC" value="9">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="DOC_TYPE" value="10">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="DOC_FRAGMENT" value="11">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="NOTATION" value="12">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="WHITESPACE" value="13">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="SIGNIFICANT_WHITESPACE" value="14">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="END_ELEMENT" value="15">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="END_ENTITY" value="16">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="XML_DECLARATION" value="17">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="LOADDTD" value="1">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="DEFAULTATTRS" value="2">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="VALIDATE" value="3">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <constant name="SUBST_ENTITIES" value="4">
    <docblock>
      <var type="int"/>
    </docblock>
  </constant>
  <member name="attributeCount" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The number of attributes on the node"/>
      <var type="int"/>
    </docblock>
  </member>
  <member name="baseURI" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The base URI of the node"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="depth" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Depth of the node in the tree, starting at 0"/>
      <var type="int"/>
    </docblock>
  </member>
  <member name="hasAttributes" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Indicates if node has attributes"/>
      <var type="bool"/>
    </docblock>
  </member>
  <member name="hasValue" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Indicates if node has a text value"/>
      <var type="bool"/>
    </docblock>
  </member>
  <member name="isDefault" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Indicates if attribute is defaulted from DTD"/>
      <var type="bool"/>
    </docblock>
  </member>
  <member name="isEmptyElement" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Indicates if node is an empty element tag"/>
      <var type="bool"/>
    </docblock>
  </member>
  <member name="localName" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The local name of the node"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="name" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The qualified name of the node"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="namespaceURI" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The URI of the namespace associated with the node"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="nodeType" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The node type for the node"/>
      <var type="int"/>
    </docblock>
  </member>
  <member name="prefix" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The prefix of the namespace associated with the node"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="value" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The text value of the node"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="xmlLang" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The xml:lang scope which the node resides"/>
      <var type="string"/>
    </docblock>
  </member>
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Close the XMLReader input"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="expand" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns a copy of the current node as a DOM object"/>
      <return type="DOMNode"/>
    </docblock>
    <parameter name="basenode" optional="true" byreference="false" type="object" class="DOMNode"/>
  </method>
  <method name="getAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the value of a named attribute"/>
      <return type="string"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getAttributeNo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the value of an attribute by index"/>
      <return type="string"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getAttributeNs" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the value of an attribute by localname and URI"/>
      <return type="string"/>
    </docblock>
    <parameter name="localName" optional="false" byreference="false" type="string"/>
    <parameter name="namespaceURI" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getParserProperty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Indicates if specified property has been set&#10;  "/>
      <return type="bool"/>
    </docblock>
    <parameter name="property" optional="false" byreference="false" type="int"/>
  </method>
  <method name="isValid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Indicates if the parsed document is valid"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="lookupNamespace" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Lookup namespace for a prefix"/>
      <return type="string"/>
    </docblock>
    <parameter name="prefix" optional="false" byreference="false" type="string"/>
  </method>
  <method name="moveToAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move cursor to a named attribute"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="moveToAttributeNo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move cursor to an attribute by index"/>
      <return type="bool"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="moveToAttributeNs" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move cursor to a named attribute"/>
      <return type="bool"/>
    </docblock>
    <parameter name="localName" optional="false" byreference="false" type="string"/>
    <parameter name="namespaceURI" optional="false" byreference="false" type="string"/>
  </method>
  <method name="moveToElement" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Position cursor on the parent Element of current Attribute"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="moveToFirstAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Position cursor on the first Attribute"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="moveToNextAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Position cursor on the next Attribute"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move cursor to next node skipping all subtrees"/>
      <return type="bool"/>
    </docblock>
    <parameter name="localname" optional="true" byreference="false" type="string"/>
  </method>
  <method name="open" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the URI containing the XML to parse"/>
      <return type="bool"/>
    </docblock>
    <parameter name="URI" optional="false" byreference="false" type="string"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </method>
  <method name="read" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to next node in document"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="readInnerXml" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve XML from current node"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="readOuterXml" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve XML from current node, including itself"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="readString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Reads the contents of the current node as a string"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="setParserProperty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set parser options"/>
      <return type="bool"/>
    </docblock>
    <parameter name="property" optional="false" byreference="false" type="int"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setRelaxNGSchema" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the filename or URI for a RelaxNG Schema"/>
      <return type="bool"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setRelaxNGSchemaSource" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the data containing a RelaxNG Schema"/>
      <return type="bool"/>
    </docblock>
    <parameter name="source" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setSchema" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Validate document against XSD"/>
      <return type="bool"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
  </method>
  <method name="xml" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="source" optional="false" byreference="false" type="string"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </method>
</class>