Files
archived-doc-pt-br/reference/array/functions/array-search.xml
Leonardo Lara Rodrigues 69d0a7d9d4 sync with en rev
2025-05-07 08:50:04 -03:00

130 lines
4.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: leonardolara Status: ready --><!-- CREDITS: lucasr,felipe,ae,lhsazevedo,leonardolara -->
<refentry xml:id="function.array-search" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_search</refname>
<refpurpose>Procura por um valor em um array e retorna sua chave correspondente caso seja encontrado</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>string</type><type>false</type></type><methodname>array_search</methodname>
<methodparam><type>mixed</type><parameter>needle</parameter></methodparam>
<methodparam><type>array</type><parameter>haystack</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>strict</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Procura a <parameter>needle</parameter> (agulha) em <parameter>haystack</parameter> (palheiro).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>needle</parameter></term>
<listitem>
<para>
O valor procurado.
</para>
<note>
<para>
Se <parameter>needle</parameter> for uma string, a comparação é feita
de uma maneira que diferencia maiúsculas e minúsculas.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>haystack</parameter></term>
<listitem>
<para>
O array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strict</parameter></term>
<listitem>
<para>
Se o terceiro parâmetro opcional <parameter>strict</parameter> for informador como &true;
então <function>array_search</function> fará uma busca por elementos
<emphasis>idênticos</emphasis> em
<parameter>haystack</parameter>. Isto significa que haverá uma checagem adicional de
<link linkend="language.types">tipos</link> no parâmetro
<parameter>needle</parameter> ao percorrer <parameter>haystack</parameter>,
de forma que os objetos sejam a mesma instância.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna a chave para <parameter>needle</parameter> se foi encontrada no
array, &false; caso contrário.
</para>
<para>
Se <parameter>needle</parameter> for encontrado em <parameter>haystack</parameter>
mais de uma vez, a primeira chave encontrada é retornada. Para retornar as chaves
de todos os valores correspondentes, utilize a função <function>array_keys</function> com o parâmetro opcional
<parameter>filter_value</parameter>.
</para>
&return.falseproblem;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo de <function>array_search</function></title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');
$key = array_search('green', $array); // $key = 2;
print_r($key);
$key = array_search('red', $array); // $key = 1;
print_r($key);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>array_keys</function></member>
<member><function>array_values</function></member>
<member><function>array_key_exists</function></member>
<member><function>in_array</function></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
-->