<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 17c238517825dfb7ec3edfef5972acd944ffbc1e Maintainer: lacatoire Status: ready -->

<refentry xml:id="function.array-unshift" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>array_unshift</refname>

<refpurpose>Empile un ou plusieurs éléments au début d'un tableau</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> ajoute les éléments <parameter>value1</parameter>,

<parameter>...</parameter>, passés

en argument au début du tableau <parameter>array</parameter>. Il est à noter que

les éléments sont ajoutés comme un tout, et qu'ils restent

dans le même ordre. Toutes les clés numériques seront modifiées afin

de commencer à partir de zéro, tandis que les clés littérales ne seront

pas touchées.

</para>

&note.reset-index;

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<para>

Le tableau d'entrée.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>values</parameter></term>

<listitem>

<para>

Valeur à empiler.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne le nouveau nombre d'éléments du tableau

<parameter>array</parameter>.

</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>

Cette fonction peut désormais être appelée avec un seul paramètre.

Auparavant, au moins deux paramètres étaient requis.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemple avec <function>array_unshift</function></title>

<programlisting role="php">

<![CDATA[

<?php

$queue = [

"orange",

"banana"

];

array_unshift($queue, "apple", "raspberry");

var_dump($queue);

?>

]]>

</programlisting>

&example.outputs;

<screen role="php">

<![CDATA[

array(4) {

[0]=>

string(5) "apple"

[1]=>

string(9) "raspberry"

[2]=>

string(6) "orange"

[3]=>

string(6) "banana"

}

]]>

</screen>

</example>

</para>

<para>

<example>

<title>Utilisation avec des tableaux associatifs</title>

<para>

Si un tableau associatif est ajouté en préfixe à un autre tableau

associatif, le tableau ajouté est indexé numériquement dans le tableau

précédent.

</para>

<programlisting role="php">

<![CDATA[

<?php

$foods = [

'apples' => [

'McIntosh' => 'red',

'Granny Smith' => 'green',

],

'oranges' => [

'Navel' => 'orange',

'Valencia' => 'orange',

],

];

$vegetables = [

'lettuce' => [

'Iceberg' => 'green',

'Butterhead' => 'green',

],

'carrots' => [

'Deep Purple Hybrid' => 'purple',

'Imperator' => 'orange',

],

'cucumber' => [

'Kirby' => 'green',

'Gherkin' => 'green',

],

];

array_unshift($foods, $vegetables);

var_dump($foods);

?>

]]>

</programlisting>

&example.outputs;

<screen role="php">

<![CDATA[

array(3) {

[0]=>

array(3) {

["lettuce"]=>

array(2) {

["Iceberg"]=>

string(5) "green"

["Butterhead"]=>

string(5) "green"

}

["carrots"]=>

array(2) {

["Deep Purple Hybrid"]=>

string(6) "purple"

["Imperator"]=>

string(6) "orange"

}

["cucumber"]=>

array(2) {

["Kirby"]=>

string(5) "green"

["Gherkin"]=>

string(5) "green"

}

}

["apples"]=>

array(2) {

["McIntosh"]=>

string(3) "red"

["Granny Smith"]=>

string(5) "green"

}

["oranges"]=>

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

-->