array-unshift.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0987e913fcaed76897aeb239c6ed83d765a895e1 Maintainer: cmb Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 6a6f43d1c490a57b452656db285de6d136055ed2 Reviewer: samesch -->
<!-- CREDITS: tom -->
<refentry xml:id="function.array-unshift" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_unshift</refname>
  <refpurpose>Fügt ein oder mehr Elemente am Anfang eines Arrays ein</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>array_unshift</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_unshift</function> fügt die übergebenen Elemente am Anfang
   von <parameter>array</parameter> ein. Beachten Sie, dass die Liste von
   Elementen als Ganzes eingefügt wird, sodass die eingefügten Elemente ihre
   Reihenfolge behalten. Die numerischen Schlüssel werden so modifiziert, dass
   sie bei Null beginnen, während String-Schlüssel unverändert bleiben.
  </para>
  &note.reset-index;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Das Eingabe-Array.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Die einzufügenden Werte.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt die neue Anzahl der in <parameter>array</parameter> enthaltenen Elemente
   zurück.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.3.0</entry>
       <entry>
        Diese Funktion kann nun mit nur einem Parameter aufgerufen werden. Zuvor
        waren mindestens zwei Parameter erforderlich.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

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

$queue = [
    "Orange",
    "Banane"
];

array_unshift($queue, "Apfel", "Himbeere");

var_dump($queue);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
array(4) {
  [0] =>
  string(5) "Apfel"
  [1] =>
  string(8) "Himbeere"
  [2] =>
  string(6) "Orange"
  [3] =>
  string(6) "Banane"
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Verwendung mit assoziativen Arrays</title>
    <para>
     Wenn ein assoziatives Array einem anderen assoziativen Array
     vorangestellt wird, wird das vorangestellte Array numerisch in das
     vorherige Array indiziert.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$lebensmittel = [
    'Äpfel' => [
        'McIntosh' => 'rot',
        'Granny Smith' => 'grün',
    ],
    'Orangen' => [
        'Navel' => 'orange',
        'Valencia' => 'orange',
    ],
];

$gemuese = [
    'Salat' => [
        'Eisberg' => 'grün',
        'Butterkopf' => 'grün',
    ],
    'Möhren' => [
        'Dunkellila Hybrid' => 'lila',
        'Imperator' => 'orange',
    ],
    'Gurken' => [
        'Kirby' => 'grün',
        'Gherkin' => 'grün',
    ],
];

array_unshift($lebensmittel, $gemuese);

var_dump($lebensmittel);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
array(3) {
  [0]=>
  array(3) {
    ["Salat"]=>
    array(2) {
      ["Eisberg"]=>
      string(4) "grün"
      ["Butterkopf"]=>
      string(4) "grün"
    }
    ["Möhren"]=>
    array(2) {
      ["Dunkellila Hybrid"]=>
      string(4) "lila"
      ["Imperator"]=>
      string(6) "orange"
    }
    ["Gurken"]=>
    array(2) {
      ["Kirby"]=>
      string(4) "grün"
      ["Gherkin"]=>
      string(4) "grün"
    }
  }
  ["Äpfel"]=>
  array(2) {
    ["McIntosh"]=>
    string(3) "rot"
    ["Granny Smith"]=>
    string(4) "grün"
  }
  ["Orangen"]=>
  array(2) {
    ["Navel"]=>
    string(6) "orange"
    ["Valencia"]=>
    string(6) "orange"
  }
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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