sbergmann Mon Feb 19 22:01:37 2001 EDT
Modified files:
/phpdoc/en/functions array.xml
Log:
Added search_array().
Index: phpdoc/en/functions/array.xml
diff -u phpdoc/en/functions/array.xml:1.55 phpdoc/en/functions/array.xml:1.56
--- phpdoc/en/functions/array.xml:1.55 Mon Jan 22 17:43:38 2001
+++ phpdoc/en/functions/array.xml Mon Feb 19 22:01:36 2001
@@ -1818,6 +1818,41 @@
</programlisting>
</example>
</para>
+ <para>
+ See also <function>search_array</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.search-array">
+ <refnamediv>
+ <refname>search_array</refname>
+ <refpurpose>Searches the array for a given value and returns the corresponding
+key if successful</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>mixed search_array</funcdef>
+ <paramdef>mixed <parameter>needle</parameter></paramdef>
+ <paramdef>array <parameter>haystack</parameter></paramdef>
+ <paramdef>bool <parameter>strict</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Searches <parameter>haystack</parameter> for
+ <parameter>needle</parameter> and returns the key if it is found in
+ the array, false otherwise.
+ </para>
+ <para>
+ If the third parameter <parameter>strict</parameter> is set to
+ <literal>TRUE</literal> then the <function>search_array</function>
+ will also check the types of the <parameter>needle</parameter>
+ in the <parameter>haystack</parameter>.
+ </para>
+ <para>
+ See also <function>in_array</function>.
+ </para>
</refsect1>
</refentry>
