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

<!-- $Revision$ -->

<!-- EN-Revision: 627fb8f8675566dfd9c3977e3ad2d9fc7b3b3876 Maintainer: yannick Status: ready -->

<!-- Reviewed: no -->

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

<refnamediv>

<refname>array_push</refname>

<refpurpose>Empile un ou plusieurs éléments à la fin d'un tableau</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>array_push</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_push</function> considère <parameter>array</parameter>

comme une pile, et empile les variables <parameter>values</parameter> à la fin de <parameter>array</parameter>.

La longueur du tableau <parameter>array</parameter> augmente d'autant.

Cela a le même effet que :

<programlisting role="php">

<![CDATA[

<?php

$array[] = $var;

?>

]]>

</programlisting>

répété pour chaque valeur.

</para>

<note>

<simpara>

Si l'on utilise la fonction <function>array_push</function> pour ajouter un

élément à un tableau, il est préférable de la remplacer par l'opérateur

<literal>$array[] = </literal> qui évite le passage par une fonction.

</simpara>

</note>

<note>

<simpara>

<function>array_push</function> émettra une alerte si le premier argument

n'est pas un tableau. Ceci diffère du comportement de

<literal>$var[]</literal> où un nouveau tableau était créé, avant PHP 7.1.0.

</simpara>

</note>

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

Les valeurs à insérer à la fin du tableau

<parameter>array</parameter>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne le nouveau nombre d'éléments dans le tableau.

</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_push</function></title>

<programlisting role="php">

<![CDATA[

<?php

$stack = array("orange", "banana");

array_push($stack, "apple", "raspberry");

print_r($stack);

?>

]]>

</programlisting>

&example.outputs;

<screen role="php">

<![CDATA[

Array

(

[0] => orange

[1] => banana

[2] => apple

[3] => raspberry

)

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>array_pop</function></member>

<member><function>array_shift</function></member>

<member><function>array_unshift</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

-->