mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
596c11440d
* Add `array_find` documentation * Add `array_find_key` documentation * Add `array_any` documentation * Add `array_all` documentation
143 lines
3.9 KiB
XML
143 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.array-find" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>array_find</refname>
|
|
<refpurpose>Returns the first element satisfying a callback function</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>array_find</methodname>
|
|
<methodparam><type>array</type><parameter>array</parameter></methodparam>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
<function>array_find</function> returns the value of the first element of an
|
|
&array; for which the given <parameter>callback</parameter> returns &true;.
|
|
If no matching element is found the function returns &null;.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The &array; that should be searched.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The callback function to call to check each element, which must be
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname><replaceable>callback</replaceable></methodname>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
|
|
</methodsynopsis>
|
|
If this function returns &true;, the value is returned from
|
|
<function>array_find</function> and the callback will not be called for
|
|
further elements.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
The function returns the value of the first element for which the
|
|
<parameter>callback</parameter> returns &true;. If no matching element is
|
|
found the function returns &null;.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>array_find</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$array = [
|
|
'a' => 'dog',
|
|
'b' => 'cat',
|
|
'c' => 'cow',
|
|
'd' => 'duck',
|
|
'e' => 'goose',
|
|
'f' => 'elephant'
|
|
];
|
|
|
|
// Find the first animal with a name longer than 4 characters.
|
|
var_dump(array_find($array, function (string $value) {
|
|
return strlen($value) > 4;
|
|
}));
|
|
|
|
// Find the first animal whose name begins with f.
|
|
var_dump(array_find($array, function (string $value) {
|
|
return str_starts_with($value, 'f');
|
|
}));
|
|
|
|
// Find the first animal where the array key is the first symbol of the animal.
|
|
var_dump(array_find($array, function (string $value, $key) {
|
|
return $value[0] === $key;
|
|
}));
|
|
|
|
// Find the first animal where the array key matching a RegEx.
|
|
var_dump(array_find($array, function ($value, $key) {
|
|
return preg_match('/^([a-f])$/', $key);
|
|
}));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
string(5) "goose"
|
|
NULL
|
|
string(3) "cow"
|
|
string(3) "dog"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>array_find_key</function></member>
|
|
<member><function>array_all</function></member>
|
|
<member><function>array_any</function></member>
|
|
<member><function>array_filter</function></member>
|
|
<member><function>array_reduce</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|