mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
cd943f94a0
Partial merge of <https://github.com/php/doc-en/pull/266>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351860 c90b9560-bf6c-de11-be94-00142212c4b1
126 lines
3.8 KiB
XML
126 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.array-search" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>array_search</refname>
|
|
<refpurpose>Searches the array for a given value and returns the first corresponding key if successful</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>
|
|
Searches for <parameter>needle</parameter> in <parameter>haystack</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>needle</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The searched value.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
If <parameter>needle</parameter> is a string, the comparison is done
|
|
in a case-sensitive manner.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>haystack</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The array.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>strict</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If the third parameter <parameter>strict</parameter> is set to &true;
|
|
then the <function>array_search</function> function will search for
|
|
<emphasis>identical</emphasis> elements in the
|
|
<parameter>haystack</parameter>. This means it will also perform a
|
|
<link linkend="language.types">strict type comparison</link> of the
|
|
<parameter>needle</parameter> in the <parameter>haystack</parameter>,
|
|
and objects must be the same instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the key for <parameter>needle</parameter> if it is found in the
|
|
array, &false; otherwise.
|
|
</para>
|
|
<para>
|
|
If <parameter>needle</parameter> is found in <parameter>haystack</parameter>
|
|
more than once, the first matching key is returned. To return the keys for
|
|
all matching values, use <function>array_keys</function> with the optional
|
|
<parameter>search_value</parameter> parameter instead.
|
|
</para>
|
|
&return.falseproblem;
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>array_search</function> example</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
|
|
-->
|