archived-doc-fr/reference/array/functions/array-splice.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cd943f94a013b74df8765ab8e1a620a916a64a85 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DavidA. -->
<refentry xml:id="function.array-splice" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_splice</refname>
  <refpurpose>Efface et remplace une portion de tableau</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_splice</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>replacement</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>array_splice</function> supprime les éléments
   désignés par <parameter>offset</parameter> et
   <parameter>length</parameter> du tableau <parameter>array</parameter> et
   les remplacent par les éléments du tableau
   <parameter>replacement</parameter>, si ce dernier est fourni.
  </para>
  <note>
   <para>
    Les clés numériques dans <parameter>array</parameter> ne sont pas préservées.
   </para>
  </note>
  <note>
   <simpara>
    Si <parameter>replacement</parameter> n'est pas un tableau, il en
    deviendra un par <link linkend="language.types.array.casting">transtypage</link>
    (i.e. <code>(array) $replacement</code>). Cela peut produire des résultats
    inattendus lors de l'utilisation d'un objet ou &null; comme
    paramètre <parameter>replacement</parameter>.
   </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>offset</parameter></term>
     <listitem>
      <para>
       Si <parameter>offset</parameter> est positif, le début de la section
       à supprimer sera à cette position en partant du début du tableau
       <parameter>array</parameter>.
      </para>
      <para>
       Si <parameter>offset</parameter> est négatif, le début de la section
       à supprimer sera à cette position en partant de la fin du tableau
       <parameter>array</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Si <parameter>length</parameter> est omis, tous les éléments du tableau
       depuis la position <parameter>offset</parameter> jusqu'à la fin du
       tableau seront supprimés.
      </para>
      <para>
       Si <parameter>length</parameter> est fourni et positif,
       alors autant d'éléments seront supprimés.
      </para>
      <para>
       Si <parameter>length</parameter> est fourni et négatif,
       alors autant d'éléments seront supprimés de la fin du tableau.
      </para>
      <para>
       Si <parameter>length</parameter> est fourni et vaut zéro,
       alors aucun élément sera supprimé.
      </para>
      <tip>
       <para>
        Pour tout supprimer depuis la position <parameter>offset</parameter>
        jusqu'à la fin du tableau lorsque <parameter>replacement</parameter>
        est aussi fourni, utiliser <code>count($input)</code> pour <parameter>length</parameter>.
       </para>
      </tip>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>replacement</parameter></term>
     <listitem>
      <para>
       Si le &array; <parameter>replacement</parameter> est fourni, alors les
       éléments supprimés sont remplacés par les éléments de ce &array;.
      </para>
      <para>
       Si l'<parameter>offset</parameter> et <parameter>length</parameter>
       sont tels que rien est supprimé, alors les éléments du &array;
       <parameter>replacement</parameter> sont insérés à la position
       <parameter>offset</parameter>.
      </para>
      <note>
       <para>
        Les clés du &array; <parameter>replacement</parameter> ne sont pas préservées.
       </para>
      </note>
      <para>
       Si <parameter>replacement</parameter> est seulement un élément il n'est pas
       nécessaire d'entourer l'élément avec <literal>array()</literal> ou des crochets,
       à moins que l'élément ne soit lui-même un tableau, un objet ou &null;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un &array; contenant les éléments extrait.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemples avec <function>array_splice</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array("red", "green", "blue", "yellow");
array_splice($input, 2);
var_dump($input);

$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, -1);
var_dump($input);

$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, count($input), "orange");
var_dump($input);

$input = array("red", "green", "blue", "yellow");
array_splice($input, -1, 1, array("black", "maroon"));
var_dump($input);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(5) "green"
}
array(2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(6) "yellow"
}
array(2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(6) "orange"
}
array(5) {
  [0]=>
  string(3) "red"
  [1]=>
  string(5) "green"
  [2]=>
  string(4) "blue"
  [3]=>
  string(5) "black"
  [4]=>
  string(6) "maroon"
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Déclaration équivalentes à des exemples de  <function>array_splice</function> divers</title>
    <para>
     Les déclarations suivantes sont équivalentes :
    </para>
    <programlisting role="php">
<![CDATA[
<?php

// ajouter deux éléments à $input
array_push($input, $x, $y);
array_splice($input, count($input), 0, array($x, $y));

// supprimer le dernier élément à $input
array_pop($input);
array_splice($input, -1);

// supprimer le premier élément à $input
array_shift($input);
array_splice($input, 0, 1);

//insérer deux éléments au début de $input
array_unshift($input, $x, $y);
array_splice($input, 0, 0, array($x, $y));

// remplace la valeur dans $input à l'index $x
$input[$x] = $y; // pour les tableaux dont les clés sont égales à l'offset
array_splice($input, $x, 1, $y);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_merge</function></member>
    <member><function>array_slice</function></member>
    <member><function>unset</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
-->