File: ReflectionParameter.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 (147 lines) | stat: -rw-r--r-- 5,990 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ReflectionParameter" namespace="" name="ReflectionParameter">
  <implements name="Reflector" full="Reflector"/>
  <member name="name" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Name of the parameter. Read-only, throws ReflectionException in attempt to write."/>
    </docblock>
  </member>
  <method name="allowsNull" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if null is allowed"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="canBePassedByValue" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether this parameter can be passed by value"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="__clone" abstract="false" static="false" final="true">
    <docblock>
      <description compact="Clone"/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct"/>
      <return type="void"/>
    </docblock>
    <parameter name="function" optional="false" byreference="false" type="string"/>
    <parameter name="parameter" optional="false" byreference="false" type="string"/>
  </constructor>
  <method name="export" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Exports"/>
      <return type="string"/>
    </docblock>
    <parameter name="function" optional="false" byreference="false" type="string"/>
    <parameter name="parameter" optional="false" byreference="false" type="string"/>
    <parameter name="return" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="getClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the type hinted class"/>
      <return type="ReflectionClass"/>
    </docblock>
  </method>
  <method name="getDeclaringClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets declaring class"/>
      <return type="ReflectionClass"/>
    </docblock>
  </method>
  <method name="getDeclaringFunction" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets declaring function"/>
      <return type="ReflectionFunctionAbstract"/>
    </docblock>
  </method>
  <method name="getDefaultValue" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets default parameter value"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getDefaultValueConstantName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the default value's constant name if default value is constant or null"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets parameter name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getPosition" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets parameter position"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets a parameter's type"/>
      <return type="ReflectionType"/>
    </docblock>
  </method>
  <method name="hasType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if parameter has a type"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isArray" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if parameter expects an array"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isCallable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether parameter MUST be callable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isDefaultValueAvailable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if a default value is available"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isDefaultValueConstant" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether the default value of this parameter is a constant"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isOptional" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if optional"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPassedByReference" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if passed by reference"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isVariadic" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if the parameter is variadic"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="To string"/>
      <return type="string"/>
    </docblock>
  </method>
</class>