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

<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

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

<refnamediv>

<refname>in_array</refname>

<refpurpose>Indica si un valor pertenece a un array</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>in_array</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 <parameter>needle</parameter> en <parameter>haystack</parameter> utilizando una comparación

flexible a menos que <parameter>strict</parameter> sea utilizado.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>needle</parameter></term>

<listitem>

<para>

El valor buscado.

</para>

<note>

<para>

Si <parameter>needle</parameter> es un &string;, la comparación

se realiza teniendo en cuenta la casilla.

</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 argumento <parameter>strict</parameter> está definido

a &true; entonces la función <function>in_array</function> verificará también que el <link linkend="language.types">tipo</link>

del argumento <parameter>needle</parameter>

coincide con el tipo del valor encontrado en <parameter>haystack</parameter>.

</para>

<note>

<para>

Antes de PHP 8.0.0, un <literal>string</literal> <parameter>needle</parameter> coincidirá

con un valor de array de <literal>0</literal> en modo no estricto y viceversa.

Esto puede llevar a resultados no deseados.

Casos similares también existen para otros tipos.

Si no se está absolutamente seguro de los tipos de valores involucrados,

siempre se debe utilizar el flag <parameter>strict</parameter> para evitar cualquier comportamiento inesperado.

</para>

</note>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve &true; si <parameter>needle</parameter> es encontrado en el array,

&false; en caso contrario.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <function>in_array</function></title>

<programlisting role="php">

<![CDATA[

<?php

$os = array("Mac", "NT", "Irix", "Linux");

if (in_array("Irix", $os)) {

echo "Got Irix";

}

if (in_array("mac", $os)) {

echo "Got mac";

}

?>

]]>

</programlisting>

<para>

La segunda condición falla, ya que <function>in_array</function>

es sensible a la casilla. El script devuelve:

</para>

<screen>

<![CDATA[

Got Irix

]]>

</screen>

</example>

</para>

<para>

<example>

<title>Ejemplo con <function>in_array</function> y modo estricto</title>

<programlisting role="php">

<![CDATA[

<?php

$a = array('1.10', 12.4, 1.13);

if (in_array('12.4', $a, true)) {

echo "'12.4' es encontrado con modo estricto\n";

}

if (in_array(1.13, $a, true)) {

echo "1.13 es encontrado con modo estricto\n";

}

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

1.13 es encontrado con modo estricto

]]>

</screen>

</example>

</para>

<para>

<example>

<title>Ejemplo con <function>in_array</function> y un array como argumento</title>

<programlisting role="php">

<![CDATA[

<?php

$a = array(array('p', 'h'), array('p', 'r'), 'o');

if (in_array(array('p', 'h'), $a)) {

echo "'ph' ha sido encontrado\n";

}

if (in_array(array('f', 'i'), $a)) {

echo "'fi' ha sido encontrado\n";

}

if (in_array('o', $a)) {

echo "'o' ha sido encontrado\n";

}

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

'ph' ha sido encontrado

'o' ha sido encontrado

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>array_search</function></member>

<member><function>isset</function></member>

<member><function>array_key_exists</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

-->