array-search.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 768876982f97b3c710c1774511094e259aea297d Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: Luffy -->
<refentry xml:id="function.array-search" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>array_search</refname>
    <refpurpose>
     在数组中搜索给定的值，如果成功则返回首个相应的键名
    </refpurpose>
   </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>string</type><type>false</type></type><methodname>array_search</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>。
    </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>array_search</function> 将在 <parameter>haystack</parameter>
       中检查<emphasis>完全相同</emphasis>的元素。
       这意味着同样严格比较 <parameter>haystack</parameter> 里 <parameter>needle</parameter> 的 <link linkend="language.types">类型</link>，并且对象需是同一个实例。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   如果找到了 <parameter>needle</parameter> 则返回它的键，否则返回 &false;。
  </para>
  <para>
   如果 <parameter>needle</parameter> 在
   <parameter>haystack</parameter>
   中出现不止一次，则返回第一个匹配的键。要返回所有匹配值的键，应该用
   <function>array_keys</function> 加上可选参数
   <parameter>filter_value</parameter> 来代替。
  </para>
  &return.falseproblem;
 </refsect1>
  <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_search</function> 例子</title>
    <programlisting role="php">
<![CDATA[
<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');

$key = array_search('green', $array); // $key = 2;
$key = array_search('red', $array);   // $key = 1;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_keys</function></member>
    <member><function>array_values</function></member>
    <member><function>array_key_exists</function></member>
    <member><function>in_array</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
-->