array-search.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 68a9c82e06906a5c00e0199307d87dd3739f719b Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.array-search" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_search</refname>
  <refpurpose>Busca un valor determinado en un array y devuelve la primera clave correspondiente en caso de éxito</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</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>
   Busca la <parameter>needle</parameter> (aguja) en <parameter>haystack</parameter> (pajar).
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       El valor a buscar.
      </para>
      <note>
       <para>
        Si <parameter>needle</parameter> es una cadena, la comparación es
        realizada de forma sensible a mayúsculas y minúsculas.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       El array
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>strict</parameter></term>
     <listitem>
      <para>
       Si el tercer parámetro, <parameter>strict</parameter>, se define como &true;
       entonces la función <function>array_search</function> también buscará
       elementos <emphasis>idénticos</emphasis> en el
       <parameter>haystack</parameter>. Esto significa que también realizará una
       <link linkend="language.types">comparación estricta de tipos</link> de la
       <parameter>needle</parameter> en el <parameter>haystack</parameter>,
       ya que los objetos deben ser la misma instancia.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la clave de la <parameter>needle</parameter> si se encuentra en
   el array, o &false; si no.
  </para>
  <para>
   Si la <parameter>needle</parameter> es encontrada en el <parameter>haystack</parameter>
   más de una vez, se devuelve la primera clave coincidente. Para devolver las claves de
   todos los valores coincidentes, se ha de usar en su lugar <function>array_keys</function>
   con el parámetro opcional <parameter>search_value</parameter>.
  </para>
  &return.falseproblem;
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.0</entry>
       <entry>
        Al igual que con todas las funciones internas de PHP a partir de la versión 5.3.0,
        <function>array_search</function> devuelve &null; si se le pasan parámetros
        inválidos.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>array_search</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$array = array(0 => 'azul', 1 => 'rojo', 2 => 'verde', 3 => 'rojo');

$clave = array_search('verde', $array); // $clave = 2;
$clave = array_search('rojo', $array);  // $clave = 1;
?>
]]>
    </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
-->