PHP Handleiding
TerugVolgende

array_splice

(PHP 4, PHP 5)

array_splice --  Verwijder een gedeelte van de array en vervang dat door iets anders

Beschrijving

array array_splice ( array input, int offset [, int length [, array replacement]] )

array_splice() verwijdert de elementen die worden aangegeven door offset en length uit de input array en vervangt ze door de elementen van de replacement array, als deze wordt gegeven. De functie geeft een array terug met daarin de verwijderde elementen.

Als offset positief is zal de rij van verwijderde elementen beginnen bij die offset in de array. Als offset negatief is, zal de rij zo ver van het einde van de array beginnen.

Als length gegeven wordt en positief is zal de rij van verwijderde elementen zoveel elementen hebben. Als length wordt gegeven en negatief is zal de rij zoveel elementen van het einde van de array stoppen. Als hij niet wordt gegeven zal de rij alle elementen bevatten van offset tot het einde van de array. Tip: om alles van offset tot het einde van de array te verwijderen wanneer replacement ook wordt gegeven kun je count($input) gebruiken als length.

Als de replacement array wordt gegeven worden de verwijderde elementen vervangen met elementen uit deze array. Als offset en length waarden hebben zodat niets wordt verwijderd worden de elementen van de replacement array toegevoegd op de plek die is gegeven in de offset parameter. Tip: als de vervanger slechts een element is is het niet nodig om array() er om heen te zetten, tenzij het element zelf een array is.

De volgende equivalenten gelden:

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                 array_splice ($input, $x, 1, $y)

Geeft een array met verwijderde elementen terug.

Voorbeeld 1. array_splice() voorbeelden

$input = array ("red", "green", "blue", "yellow");
array_splice ($input, 2);
// $input is nu ("red", "green")

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

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

$input = array ("red", "green", "blue", "yellow");
array_splice ($input, -1, 1, array("black", "maroon"));
// $input is nu array ("red", "green",
//          "blue", "black", "maroon")

Zie ook array_slice().

TerugBeginVolgende
array_sliceOmhoogarray_sum