array-key-exists.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0b15fb2e4be999af651dcbc118059c97ee5ed4c9 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.array-key-exists" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_key_exists</refname>
  <refpurpose>指定したキーまたは添字が配列にあるかどうかを調べる</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>array_key_exists</methodname>
   <methodparam><type>mixed</type><parameter>key</parameter></methodparam>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した <parameter>key</parameter> が配列に設定されている場合、
   <function>array_key_exists</function> は &true; を返します。
   <parameter>key</parameter> は配列添字として使用できる全ての値を使用可能です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       調べる値。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       キーが存在するかどうかを調べたい配列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <note>
   <para>
    <function>array_key_exists</function> は、最初のレベルのキーだけを捜します。
    多次元配列のネストされたキーは、この関数では見つけられません。
   </para>
  </note>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_key_exists</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$search_array = array('first' => 1, 'second' => 4);
if (array_key_exists('first', $search_array)) {
    echo "この配列には 'first' という要素が存在します";
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <example>
   <title><function>array_key_exists</function> 対 <function>isset</function></title>
   <para>
    <function>isset</function> は &null; 値を持つ配列キーに対して
    &true; を返しません。一方、<function>array_key_exists</function> は
    &true; を返します。
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$search_array = array('first' => null, 'second' => 4);

// false を返します
isset($search_array['first']);

// true を返します
array_key_exists('first', $search_array);
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
    <para>
     過去との互換性を保つため、<parameter>key</parameter>
     が仮に <parameter>array</parameter> で指定したオブジェクトのプロパティであっても
     <function>array_key_exists</function> は &true; を返します。
     しかし、この挙動に頼ってはいけません。
     <parameter>array</parameter> にはオブジェクトではなく配列を渡すようにしましょう。
    </para>
    <para>
     オブジェクトのプロパティが存在するかどうかを調べるには、
     <function>property_exists</function> を使いましょう。
    </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>isset</function></member>
    <member><function>array_keys</function></member>
    <member><function>in_array</function></member>
    <member><function>property_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
-->