array-key-exists.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 89fe795cc8bcf1b5ff9eb894bff51f006db66a65 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<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 class="union"><type>string</type><type>int</type><type>float</type><type>bool</type><type>resource</type><type>null</type></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="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>key</parameter> 参数现在接受
       <parameter>bool</parameter>、<parameter>float</parameter>、<parameter>int</parameter>、<parameter>null</parameter>、<parameter>resource</parameter>
       和 <parameter>string</parameter> 作为参数。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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 "The 'first' element is in the array";
}
?>
]]>
    </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> 会。
   </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>
     由于为了兼容以前版本，如果 <type>object</type> 当做 <parameter>array</parameter> 传入 
     <function>array_key_exists</function>，同时 <parameter>key</parameter> 是对象的属性，也会返回 &true;。
     此行为在 PHP 7.4.0 弃用且在 PHP 8.0.0 移除。
    </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
-->