(PHP 4, PHP 5, PHP 7)
array_splice — Efface et remplace une portion de tableau
&$input
, int $offset
[, int $length = 0
[, mixed $replacement = array()
]] )
array_splice() supprime les éléments
désignés par offset et
length du tableau input et
les remplace par les éléments du tableau
replacement, si ce dernier est présent.
Notez que les clés numériques de input
ne sont pas préservées.
Note: Si
replacementn'est pas un tableau, il en deviendra un par transtypage (i.e.(array) $replacement). Cela peut conduire en un résultat non prévu lors de l'utilisation d'un objet ouNULLcomme paramètrereplacement.
inputLe tableau d'entrée.
offset
Si offset est positif, la série commencera
à cet offset dans le tableau input.
Si offset est négatif, cette série
commencera à l'offset offset, mais en commençant
à la fin du tableau input.
length
Si length est donné et positif, alors la
série aura autant d'éléments. Si length
est donné et négatif, les éléments seront pris
dans l'ordre inverse.
Si length est omis, la séquence supprimera tous les
éléments du tableau, depuis l'offset offset
jusqu'à la fin du tableau. Si le paramètre length
est spécifié et vaut zéro, aucun élément ne sera supprimé.
Conseil : pour supprimer tous les éléments du tableau depuis
offset jusqu'à la fin, même si un tableau
de remplacement replacement est spécifié, utilisez
count($input) à la place de
length.
replacement
Si replacement est précisé, alors les
éléments supprimés sont remplacés par les
éléments de ce tableau.
Si l'offset
et length sont tels que la taille du tableau ne
change pas, alors les éléments du tableau de remplacement
replacement sont
insérés à partir de l'offset offset.
Notez que les clés numériques de input
ne sont pas préservées.
Si le tableau de remplacement replacement
ne contient qu'un seul élément, il n'est pas obligatoire de
forcer le type en tableau avec array(),
à moins que cette variable ne soit elle-même un tableau, un objet ou NULL.
Retourne le tableau contenant les éléments supprimés.
Exemple #1 Exemple avec array_splice()
<?php
$input = array("red", "green", "blue", "yellow");
array_splice($input, 2);
// $input is now array("red", "green")
$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, -1);
// $input is now array("red", "yellow")
$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, count($input), "orange");
// $input is now array("red", "orange")
$input = array("red", "green", "blue", "yellow");
array_splice($input, -1, 1, array("black", "maroon"));
// $input is now array("red", "green",
// "blue", "black", "maroon")
$input = array("red", "green", "blue", "yellow");
array_splice($input, 3, 0, "purple");
// $input is now array("red", "green",
// "blue", "purple", "yellow");
?>
Exemple #2 Exemple avec array_splice()
L'exemple suivant modifie les valeurs de $input de la même façon :
<?php
array_push($input, $x, $y);
array_splice($input, count($input), 0, array($x, $y));
array_pop($input);
array_splice($input, -1);
array_shift($input);
array_splice($input, 0, 1);
array_unshift($input, $x, $y);
array_splice($input, 0, 0, array($x, $y));
$input[$x] = $y; // pour les tableaux dont les clés sont égales à l'offset
array_splice($input, $x, 1, $y);
?>