File: gettype.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 (154 lines) | stat: -rw-r--r-- 4,461 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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionparameter.gettype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ReflectionParameter::getType</refname>
  <refpurpose>Gets a parameter's type</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ReflectionParameter">
   <modifier>public</modifier> <type class="union"><type>ReflectionType</type><type>null</type></type><methodname>ReflectionParameter::getType</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets the associated type of a parameter.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a <classname>ReflectionType</classname> object if a parameter type is
   specified, &null; otherwise.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><methodname>ReflectionParameter::getType</methodname> Usage as of PHP 7.1.0</title>
    <simpara>
     As of PHP 7.1.0, <methodname>ReflectionType::__toString</methodname> is deprecated, and
     <methodname>ReflectionParameter::getType</methodname> <emphasis>may</emphasis> return an
     instance of <classname>ReflectionNamedType</classname>. To get the name of the parameter type,
     <methodname>ReflectionNamedType</methodname> is available in this case.
    </simpara>
    <programlisting role="php">
<![CDATA[
<?php
function someFunction(int $param, $param2) {}

$reflectionFunc = new ReflectionFunction('someFunction');
$reflectionParams = $reflectionFunc->getParameters();
$reflectionType1 = $reflectionParams[0]->getType();
$reflectionType2 = $reflectionParams[1]->getType();

assert($reflectionType1 instanceof ReflectionNamedType);
echo $reflectionType1->getName(), PHP_EOL;
var_dump($reflectionType2);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int
NULL
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><methodname>ReflectionParameter::getType</methodname> Usage before PHP 7.1.0</title>
    <programlisting role="php">
<![CDATA[
<?php
function someFunction(int $param, $param2) {}

$reflectionFunc = new ReflectionFunction('someFunction');
$reflectionParams = $reflectionFunc->getParameters();
$reflectionType1 = $reflectionParams[0]->getType();
$reflectionType2 = $reflectionParams[1]->getType();

echo $reflectionType1, PHP_EOL;
var_dump($reflectionType2);
?>
]]>
    </programlisting>
    &example.outputs.70;
    <screen>
<![CDATA[
int
NULL
]]>
    </screen>
   </example>
   <example>
   <title><methodname>ReflectionParameter::getType</methodname> Usage in PHP 8.0.0 and later</title>
    <para>
     As of PHP 8.0.0, this method may return a <classname>ReflectionNamedType</classname> instance or
     a <classname>ReflectionUnionType</classname> instance.  The latter is a collection of the former.
     To analyze a type, it is often convenient to normalize it to an array of <classname>ReflectionNamedType</classname>
     objects.  The following function will return an array of <literal>0</literal> or more <classname>ReflectionNamedType</classname>
     instances.
    </para>
   <programlisting role="php">
<![CDATA[
<?php
function getAllTypes(ReflectionParameter $reflectionParameter): array
{
    $reflectionType = $reflectionParameter->getType();

    if (!$reflectionType) return [];

    return $reflectionType instanceof ReflectionUnionType
        ? $reflectionType->getTypes()
        : [$reflectionType];
}
?>
]]>
   </programlisting>
  </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>ReflectionParameter::hasType</methodname></member>
    <member><methodname>ReflectionType::__toString</methodname></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- 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
-->