in-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8cd7c0d8c574903e149c1da0689a8728cdf909d4 Maintainer: hirokawa Status: ready -->
<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>haystack</parameter> 内の <parameter>needle</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>
       三番目のパラメータ <parameter>strict</parameter> が
       &true; に設定された場合、
       <function>in_array</function> は、<parameter>haystack</parameter>
       の中の <parameter>needle</parameter> の
       <link linkend="language.types">型</link>も確認します。
      </para>
      <note>
       <para>
        PHP 8.0.0 より前のバージョンでは、
        strict フラグが指定されていない場合に、
        配列の値が <literal>0</literal>
        の場合でも文字列にマッチしてしまっていました。逆も同じです。
        これにより、望ましくない結果が生じる可能性があります。
        似たようなエッジケースは他の型でも存在します。
        値の型が完全にわからない場合には、
        予期せぬ振る舞いを避けるために常に
        <parameter>strict</parameter> フラグを使うようにして下さい。
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   配列で <parameter>needle</parameter> が見つかった場合に
   &true;、それ以外の場合は、&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 "Got Irix";
}
if (in_array("mac", $os)) {
    echo "Got mac";
}
?>
]]>
    </programlisting>
    <para>
     二番目の条件式は失敗します。<function>in_array</function>
     は大文字小文字を区別するからです。したがって次のような出力になります。
    </para>
    <screen>
<![CDATA[
Got Irix
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>strict を指定した <function>in_array</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array('1.10', 12.4, 1.13);

if (in_array('12.4', $a, true)) {
    echo "'12.4' found with strict check\n";
}

if (in_array(1.13, $a, true)) {
    echo "1.13 found with strict check\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1.13 found with strict check
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>needleが配列の場合の <function>in_array</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array(array('p', 'h'), array('p', 'r'), 'o');

if (in_array(array('p', 'h'), $a)) {
    echo "'ph' was found\n";
}

if (in_array(array('f', 'i'), $a)) {
    echo "'fi' was found\n";
}

if (in_array('o', $a)) {
    echo "'o' was found\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
  'ph' was found
  'o' was found
]]>
    </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
-->