<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: dfd68fd22aef25658bc9348176b55b504d26ab11 Maintainer: KentarouTakeda Status: ready -->

<!-- CREDITS: KentarouTakeda -->

<refentry xml:id="function.array-find" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>array_find</refname>

<refpurpose>コールバック関数を満たす最初の要素を返す</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> は、指定された

<parameter>callback</parameter> が &true; を返す &array; の最初の要素を返します。

見つからない場合 &null; を返します。

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<simpara>

検索する &array;。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>callback</parameter></term>

<listitem>

<para>

各要素を調べるコールバック関数。シグネチャは次の通りです:

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

この関数が &true; を返すと、

その要素が <function>array_find</function> から返され、

以降の要素に対してはコールバックは呼び出されません。

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

<parameter>callback</parameter> が &true; を返す最初の要素を返します。

一致する要素が見つからない場合、

&null; を返します。

</simpara>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example>

<title><function>array_find</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

$array = [

'a' => 'dog',

'b' => 'cat',

'c' => 'cow',

'd' => 'duck',

'e' => 'goose',

'f' => 'elephant'

];

// 名前が4文字より長い最初の動物を探します。

var_dump(array_find($array, function (string $value) {

return strlen($value) > 4;

}));

// 名前がfで始まる最初の動物を探します。

var_dump(array_find($array, function (string $value) {

return str_starts_with($value, 'f');

}));

// キーが動物の名前の最初の文字と一致する最初の動物を探します。

var_dump(array_find($array, function (string $value, $key) {

return $value[0] === $key;

}));

// キーが正規表現にマッチする最初の動物を探します。

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

-->