mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 11:58:55 +00:00
fb5362c8b9
* Clarify what a built-in type is. * Add PHP 8 equivalent of ReflectionParameter::isArray(). * Leave note on ReflectionParameter::getClass() for what to use instead. * Clarify order of the array in getParameters(). * Add example to aid working with union types. * Add updated equivalent of isCallable().
99 lines
2.4 KiB
XML
99 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="reflectionparameter.isarray" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ReflectionParameter::isArray</refname>
|
|
<refpurpose>Checks if parameter expects an array</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
&warn.deprecated.function-8-0-0;
|
|
<para>See the example below for an alternative way to derive this information.</para>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>ReflectionParameter::isArray</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Checks if the parameter expects an array.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&true; if an <type>array</type> is expected, &false; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>PHP 8.0.0 equivalent</title>
|
|
<para>
|
|
As of PHP 8.0.0, the following code will report if a type declares arrays,
|
|
including as part of a union.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function declaresArray(ReflectionParameter $reflectionParameter): bool
|
|
{
|
|
$reflectionType = $reflectionParameter->getType();
|
|
|
|
if (!$reflectionType) return false;
|
|
|
|
$types = $reflectionType instanceof ReflectionUnionType
|
|
? $reflectionType->getTypes()
|
|
: [$reflectionType];
|
|
|
|
return in_array('array', array_map(fn(ReflectionNamedType $t) => $t->getName(), $types));
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ReflectionParameter::isOptional</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
|
|
-->
|