array-is-list.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5ecd5e8e50f0f47dce7341ddc95334af62d9e770 Maintainer: samesch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.array-is-list" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_is_list</refname>
  <refpurpose>Prüft, ob das angegebene Array eine Liste ist</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>array_is_list</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
  </methodsynopsis>
  <para>
   Überprüft, ob das angegebene <parameter>array</parameter> eine Liste ist.
   Ein &array; wird als Liste betrachtet, wenn seine Schlüssel aus
   aufeinanderfolgenden Zahlen von <literal>0</literal> bis
   <literal>count($array)-1</literal> besteht.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Das auszuwertende &array;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt &true; zurück, wenn <parameter>array</parameter> eine Liste ist,
   andernfalls &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_is_list</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

array_is_list([]); // true
array_is_list(['apple', 2, 3]); // true
array_is_list([0 => 'apple', 'orange']); // true

// Das Array beginnt nicht bei 0
array_is_list([1 => 'apple', 'orange']); // false

// Die Schlüssel sind nicht in der richtigen Reihenfolge
array_is_list([1 => 'apple', 0 => 'orange']); // false

// Die Schlüssel sind nicht ganzzahlig
array_is_list([0 => 'apple', 'foo' => 'bar']); // false

// Die Schlüssel sind nicht fortlaufend
array_is_list([0 => 'apple', 2 => 'bar']); // false
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Diese Funktion gibt bei leeren Arrays &true; zurück.
   </para>
  </note>
 </refsect1>

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