in-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: hholzgra Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: tom, simp -->
<refentry xml:id="function.in-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>in_array</refname>
  <refpurpose>Prüft, ob ein Wert in einem Array existiert</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>in_array</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>
   Diese Funktion sucht in <parameter>haystack</parameter> nach
   <parameter>needle</parameter>. Wenn <parameter>strict</parameter> gesetzt
   ist, wird dabei auch der Typ des Elements beachtet.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       Der gesuchte Wert.
      </para>
      <note>
       <para>
        Ist <parameter>needle</parameter> ein String, so wird bei der Suche
        die Groß- und Kleinschreibung beachtet.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       Das zu durchsuchende Array.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>strict</parameter></term>
     <listitem>
      <para>
       Wenn der dritte Parameter auf &true; gesetzt wird, vergleicht
       <function>in_array</function> nicht nur den Wert, sondern auch
       den <link linkend="language.types">Typ</link> des gesuchten
       Wertes <parameter>needle</parameter> mit den Elementen des
       Arrays.
      </para>
      <note>
       <para>
        Vor PHP 8.0.0 passt ein <parameter>needle</parameter>-Wert vom Typ
        <literal>string</literal> im nicht-strikten Modus auf einen Array-Wert
        von <literal>0</literal> und umgekehrt. Das kann zu unerwünschten
        Ergebnissen führen. Ähnliche Grenzfälle gibt es auch für andere Typen.
        Wenn nicht absolut sicher ist, um welche Art von Werten es sich
        handelt, sollte immer das Flag <parameter>strict</parameter> verwendet
        werden, um ein unerwartetes Verhalten zu vermeiden.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt &true; zurück wenn <parameter>needle</parameter> im
   Array gefunden wird, sonst &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>in_array</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$os = array("Mac", "NT", "Irix", "Linux");
if (in_array("Irix", $os)) {
    echo "Irix enthalten";
}
if (in_array("mac", $os)) {
    echo "mac enthalten";
}
?>
]]>
    </programlisting>
    <para>
     Der zweite Vergleich schlägt fehl, da <function>in_array</function>
     Groß- und Kleinschreibung unterscheidet, die Ausgabe sieht daher
     so aus:
    </para>
    <screen>
<![CDATA[
Irix enthalten
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>in_array</function>-Beispiel mit 'strict'</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array('1.10', 12.4, 1.13);

if (in_array('12.4', $a, true)) {
    echo "'12.4' bei strenger Prüfung gefunden\n";
}

if (in_array(1.13, $a, true)) {
    echo "1.13 Bei strenger Prüfung gefunden\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1.13 bei strenger Prüfung gefunden
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>in_array</function> mit Array als Suchwert</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array(array('p', 'h'), array('p', 'r'), 'o');

if (in_array(array('p', 'h'), $a)) {
    echo "'ph' gefunden\n";
}

if (in_array(array('f', 'i'), $a)) {
    echo "'fi' gefunden\n";
}

if (in_array('o', $a)) {
    echo "'o' gefunden\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
'ph' gefunden
'o' gefunden
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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