PHP - array_splice

Třída

Kořen \ Bez třídy

Metoda - array_splice

(PHP 4, PHP 5, PHP 7)

Funkce vyjme vybrané prvky pole a nahradí je novými, pokud je uvedeme. Zároveň vrací pole s vyjmutými prvky.

Procedurální

• function array_splice (array &$input, int $offset, int $length = count($input), mixed $replacement = array()) : array

Parametry

Název	Datový typ	Výchozí hodnota	Popis
&$input	array		Hlavní (vstupní) pole.
$offset	int		Určuje počáteční bod, od kterého se začnou vyjímat (nahrazovat) prvky hlavního pole. Když se jedná o kladné číslo, počátek je brán od začátku pole. V případě záporného čísla se počátek počítá od konce pole směrem k jeho začátku. 0 (nula), počátek je první prvek pole.
$length	int	count($input)	Určuje, kolik prvků vstupního pole bude vyjmuto (nahrazeno). V případě kladného čísla jsou vyjmuty prvky od počátečního bodu směrem ke konci poli. V případě záporného čísla se poslední nahrazovaný prvek určí od konce pole směrem k jeho začátku. Pokud není určeno, vyjmou se všechny prvky od počátečního bodu až do konce pole.
$replacement	mixed	array()	Prvky daného pole budou vložené do vstupního pole. Když se jedná jen o jeden prvek, nemusí se jednat o pole, ale může být předán jako textový řetězec.

Návratové hodnoty

Vrací: array

Funkce vrací pole obsahující vyjmuté prvky z původního (hlavního) pole.

Příklady

V první ukázce zadáme první dva parametry, funkce vyjme prvky z prvního pole ($auta) a ty uložíme do jiného pole ($vracenePole).

<?php
$auta = array("Mercedes", "BMW", "Audi", "VW", "Mazda", "Toyota", "Subaru");
$vracenePole = array_splice($auta, 4);
echo "Původní pole: "; print_r($auta);
echo "<br>";
echo "Vrácené pole: "; print_r($vracenePole);

Přidáme třetí parametr, který určuje počet prvků k vyjmutí (v tomto případě 2).

<?php
$auta = array("Mercedes", "BMW", "Audi", "VW", "Mazda", "Toyota", "Subaru");
$vracenePole = array_splice($auta, -5, 2);
echo "Původní pole: "; print_r($auta);
echo "<br>";
echo "Vrácené pole: "; print_r($vracenePole);

Přidáme poslední parametr (pole $auta2). Prvky tohoto pole nahradí vyjmuté prvky z originálního pole.

<?php
$auta = array("Mercedes", "BMW", "Audi", "VW", "Mazda", "Toyota", "Subaru");
$auta2 = array("Opel", "Porsche", "Lexus", "Honda");
$vracenePole = array_splice($auta, 2, -2, $auta2);
echo "Původní pole: "; print_r($auta);
echo "<br>";
echo "Vrácené pole: "; print_r($vracenePole);