in-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 8cd7c0d8c574903e149c1da0689a8728cdf909d4 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.in-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>in_array</refname>
  <refpurpose>Проверяет, существует ли значение в массиве</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>
   Функция выполняет поиск значения <parameter>needle</parameter> в массиве <parameter>haystack</parameter>.
   Функция сравнивает значения в нестрогом режиме, если только строгий режим
   не установили через параметр <parameter>strict</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       Искомое значение.
      </para>
      <note>
       <para>
        Функция сравнивает значения с учётом регистра,
        если значение <parameter>needle</parameter> — строка.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       Массив.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>strict</parameter></term>
     <listitem>
      <para>
       Функция <function>in_array</function> также сопоставит <link linkend="language.types">типы</link>
       значения <parameter>needle</parameter> со значениями в массиве <parameter>haystack</parameter>,
       если для третьего параметра <parameter>strict</parameter> установили значение &true;.
      </para>
      <note>
       <para>
        До PHP 8.0.0 в нестрогом режиме функция считала значение параметра <parameter>needle</parameter>
        частью массива, если искомое значение принадлежало типу <literal>string</literal>,
        а массив содержал целочисленное значение <literal>0</literal>, и наоборот.
        Такое «соответствие» давало нежелательный результат. Аналогичные пограничные случаи встречаются и для других типов.
        Лучше предпочесть и установить через флаг <parameter>strict</parameter> строгий режим,
        чтобы избежать неожиданного поведения в случаях, когда невозможно достоверно установить типы значений.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает &true;, если нашла значение <parameter>needle</parameter>
   в массиве, иначе &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>in_array</function></title>
    <programlisting role="php">
<![CDATA[
<?php

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

if (in_array("Irix", $os)) {
    echo "Функция нашла значение 'Irix'";
}

if (in_array("mac", $os)) {
    echo "Функция нашла значение 'mac'";
}

?>
]]>
    </programlisting>
    <para>
     Функция <function>in_array</function> не найдёт второго совпадения, потому что
     чувствительна к регистру, поэтому приведённая программа выведет:
    </para>
    <screen>
<![CDATA[
Функция нашла значение 'Irix'
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Пример использования функции <function>in_array</function> с параметром strict</title>
    <programlisting role="php">
<![CDATA[
<?php

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

if (in_array('12.4', $a, true)) {
    echo "Функция нашла значение '12.4' при строгой проверке\n";
}

if (in_array(1.13, $a, true)) {
    echo "Функция нашла значение '1.13' при строгой проверке\n";
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Функция нашла значение '1.13' при строгой проверке
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>
     Пример использования функции <function>in_array</function> с массивом в качестве аргумента needle
    </title>
    <programlisting role="php">
<![CDATA[
<?php

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

if (in_array(array('p', 'h'), $a)) {
    echo "Функция нашла значение 'ph'\n";
}

if (in_array(array('f', 'i'), $a)) {
    echo "Функция нашла значение 'fi'\n";
}

if (in_array('o', $a)) {
    echo "Функция нашла значение 'o'\n";
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Функция нашла значение 'ph'
Функция нашла значение 'o'
]]>
    </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
-->