<?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
-->
