File: ReflectionClass.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 (364 lines) | stat: -rw-r--r-- 15,151 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ReflectionClass" namespace="" name="ReflectionClass">
  <implements name="Reflector" full="Reflector"/>
  <constant name="IS_IMPLICIT_ABSTRACT" value="16">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="IS_EXPLICIT_ABSTRACT" value="32">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="IS_FINAL" value="64">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <member name="name" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Name of the class. Read-only, throws ReflectionException in attempt to write."/>
    </docblock>
  </member>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a ReflectionClass"/>
      <return type="void"/>
    </docblock>
    <parameter name="argument" optional="false" byreference="false" type="object" class="mixed"/>
  </constructor>
  <method name="export" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Exports a class"/>
      <return type="string"/>
    </docblock>
    <parameter name="argument" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="return" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="getConstant" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets defined constant"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getConstants" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets constants"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getConstructor" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the constructor of the class"/>
      <return type="ReflectionMethod"/>
    </docblock>
  </method>
  <method name="getDefaultProperties" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets default properties">Gets default properties from a class (including inherited properties).</description>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getDocComment" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets doc comments"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getEndLine" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets end line"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getExtension" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets a ReflectionExtension object for the extension which defined the class"/>
      <return type="ReflectionExtension"/>
    </docblock>
  </method>
  <method name="getExtensionName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the name of the extension which defined the class"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getFileName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the filename of the file in which the class has been defined"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getInterfaceNames" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the interface names"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getInterfaces" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the interfaces"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets a ReflectionMethod for a class method"/>
      <return type="ReflectionMethod"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getMethods" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets an array of methods"/>
      <return type="array"/>
    </docblock>
    <parameter name="filter" optional="true" byreference="false" type="int"/>
  </method>
  <method name="getModifiers" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the class modifiers"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets class name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getNamespaceName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets namespace name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getParentClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets parent class"/>
      <return type="ReflectionClass"/>
    </docblock>
  </method>
  <method name="getProperties" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets properties"/>
      <return type="array"/>
    </docblock>
    <parameter name="filter" optional="true" byreference="false" type="int"/>
  </method>
  <method name="getProperty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets a ReflectionProperty for a class's property"/>
      <return type="ReflectionProperty"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getReflectionConstant" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets a ReflectionClassConstant for a class's constant"/>
      <return type="ReflectionClassConstant"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getReflectionConstants" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets class constants"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getShortName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets short name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getStartLine" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets starting line number"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getStaticProperties" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets static properties"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getStaticPropertyValue" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets static property value"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="def_value" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="getTraitAliases" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an array of trait aliases"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getTraitNames" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an array of names of traits used by this class"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getTraits" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an array of traits used by this class"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="hasConstant" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if constant is defined"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="hasMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if method is defined"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="hasProperty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if property is defined"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="implementsInterface" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Implements interface"/>
      <return type="bool"/>
    </docblock>
    <parameter name="interface" optional="false" byreference="false" type="string"/>
  </method>
  <method name="inNamespace" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if in namespace"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isAbstract" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if class is abstract"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isAnonymous" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if class is anonymous"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isCloneable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether this class is cloneable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isFinal" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if class is final"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isInstance" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks class for instance"/>
      <return type="bool"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="isInstantiable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if the class is instantiable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isInterface" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if the class is an interface"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isInternal" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if class is defined internally by an extension, or the core"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isIterable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether this class is iterable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isIterateable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if iterateable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isSubclassOf" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if a subclass"/>
      <return type="bool"/>
    </docblock>
    <parameter name="class" optional="false" byreference="false" type="string"/>
  </method>
  <method name="isTrait" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether this is a trait"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isUserDefined" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if user defined"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="newInstance" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new class instance from given arguments"/>
      <return type="object"/>
    </docblock>
    <parameter name="..." optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="newInstanceArgs" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new class instance from given arguments"/>
      <return type="object"/>
    </docblock>
    <parameter name="args" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="newInstanceWithoutConstructor" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new class instance without invoking the constructor"/>
      <return type="object"/>
    </docblock>
  </method>
  <method name="setStaticPropertyValue" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets static property value"/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the string representation of the ReflectionClass object"/>
      <return type="string"/>
    </docblock>
  </method>
</class>