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

<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: yannick Status: ready -->

<!-- Reviewed: yes -->

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

<refnamediv>

<refname>array_pad</refname>

<refpurpose>Complète un tableau avec une valeur jusqu'à la longueur spécifiée</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>array</type><methodname>array_pad</methodname>

<methodparam><type>array</type><parameter>array</parameter></methodparam>

<methodparam><type>int</type><parameter>length</parameter></methodparam>

<methodparam><type>mixed</type><parameter>value</parameter></methodparam>

</methodsynopsis>

<para>

<function>array_pad</function> retourne une copie du tableau

<parameter>array</parameter> complétée jusqu'à la taille de

<parameter>length</parameter> avec la valeur

<parameter>value</parameter>. Si

<parameter>length</parameter> est positif, alors le tableau

est complété à droite, s'il est négatif, il est complété à gauche.

Si la valeur absolue de <parameter>length</parameter> est

inférieure ou égale à la taille du tableau <parameter>array</parameter>,

alors le tableau n'est pas complété.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

Tableau initial de valeurs à compléter.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>length</parameter></term>

<listitem>

<para>

Nouvelle taille du tableau.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>value</parameter></term>

<listitem>

<para>

Valeur à insérer si l'argument <parameter>array</parameter>

est plus petit que l'argument <parameter>length</parameter>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne une copie du tableau

<parameter>array</parameter> complétée jusqu'à la taille de

<parameter>length</parameter> avec la valeur

<parameter>value</parameter>. Si

<parameter>length</parameter> est positif, alors le tableau

est complété à droite, s'il est négatif, il est complété à gauche.

Si la valeur absolue de <parameter>length</parameter> est

inférieure ou égale à la taille du tableau <parameter>array</parameter>,

alors le tableau n'est pas complété.

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

<entry>

Avant la version 8.3, seuls 1048576 éléments pouvaient être ajoutés en une seule fois.

Maintenant, cela est limité uniquement par la taille maximale d'un tableau.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemple avec <function>array_pad</function></title>

<programlisting role="php">

<![CDATA[

<?php

$input = array(12, 10, 9);

$result = array_pad($input, 5, 0);

// Le résultat est : array(12, 10, 9, 0, 0)

echo join(', ', $result), PHP_EOL;

$result = array_pad($input, -7, -1);

// Le résultat est : array(-1, -1, -1, -1, 12, 10, 9)

echo join(', ', $result), PHP_EOL;

$result = array_pad($input, 2, "noop");

// pas complété

echo join(', ', $result), PHP_EOL;

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>array_fill</function></member>

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

-->