Files
archived-doc-pt-br/reference/array/functions/array-find-key.xml
Leonardo Lara Rodrigues cb2f33e62a fix translation
2025-06-03 12:06:42 -03:00

143 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 596c11440dc232b8ed1836d7e3afe2ed5b225a7b Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xml:id="function.array-find-key" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_find_key</refname>
<refpurpose>Retorna a chave do primeiro elemento que satisfaz uma função de retorno</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>array_find_key</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>array_find_key</function> retorna a chave do primeiro elemento de um
&array; para o qual a função <parameter>callback</parameter> retorna &true;.
Se nenhum elemento correspondente for encontrado, a função retorna &null;.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<simpara>
O &array; a ser pesquisado.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
A função de retorno a ser chamada para verificar cada elemento, que precisa ter a seguinte assinatura:
<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>
Se esta função retornar &true;, a chave é retornada por
<function>array_find_key</function> e a função de retorno não será chamada para
os elementos restantes.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
A função retorna a chave do primeiro elemento para o qual
<parameter>callback</parameter> retorna &true;. Se nenhum elemento correspondente for
encontrado, a função retorna &null;.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <function>array_find_key</function></title>
<programlisting role="php">
<![CDATA[
<?php
$array = [
'a' => 'cachorro',
'b' => 'gato',
'c' => 'vaca',
'd' => 'pato',
'e' => 'elefante',
'f' => 'ganso'
];
// Encontra o primeiro animal com nome mais longo que 4 caracteres.
var_dump(array_find_key($array, function (string $value) {
return strlen($value) > 4;
}));
// Encontra o primeiro animal cujo nome começa com f.
var_dump(array_find_key($array, function (string $value) {
return str_starts_with($value, 'f');
}));
// Encontra o primeiro animal onde a chave do array é a primeira letra do animal.
var_dump(array_find_key($array, function (string $value, $key) {
return $value[0] === $key;
}));
// Encontra o primeiro animal onde o chave do array corresponde a uma expressão regular.
var_dump(array_find_key($array, function ($value, $key) {
return preg_match('/^([a-f])$/', $key);
}));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(1) "a"
NULL
string(1) "e"
string(1) "a"
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>array_find</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
-->