PHP - extract

Třída

Metoda - extract

(PHP 4, PHP 5, PHP 7)

Rozbalí proměnné z pole do současného scope. Jako názvy proměnných jsou použity klíče v poli, funkce bere v úvahu validní jména pro proměnné a také, zda proměnná již existuje.

Jedná se o potenciálně nebezpečnou funkci, měli bychom myslet na to, jaká data se do vybalovaného pole mohou dostat a jestli je uživatel schopen do tohoto pole zasahovat.

Procedurální

function extract (array &$array, int $flags = EXTR_OVERWRITE, string $prefix = NULL) : int

Parametry

Název	Datový typ	Výchozí hodnota	Popis
&$array	array		Vstupní pole.
$flags	int	EXTR_OVERWRITE	Určuje, jak jsou ošetřovány kolize a neplatné vstupy. EXTR_OVERWRITE- Přepíše existující proměnné. EXTR_SKIP - Nepřepíše existující proměnné. EXTR_PREFIX_SAME - Předsadí jméno proměnné prefixem v případě, že již existuje. EXTR_PREFIX_ALL - Předsadí vždy všechny názvy proměnných prefixem. EXTR_PREFIX_INVALID - Předsadí pouze nevalidní názvy proměnných (např. číselné). EXTR_IF_EXISTS - Přepíše proměnnou pouze pokud existuje, v ostatních případech nebude proměnná založena. Založením povolených proměnných lze ošetřit vybalení toho správného např. z POST. EXTR_PREFIX_IF_EXISTS - Předsadí názvy proměnných prefixem v případě, že již existuje. Ty neexistující nebudou vybaleny. EXTR_REFS - Vybalí proměnné jako reference na původní prvky pole. Tento flag lze kombinovat s ostatními.
$prefix	string	NULL	Třetí, nepovinný parametr je prefix názvu proměnné. Je vyžadován pouze u flagů: EXTR_PREFIX_SAME, EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID nebo EXTR_PREFIX_IF_EXISTS. Za prefix je automaticky přidáno podtržítko ("_").

Název

Datový typ

Výchozí hodnota

Popis

&$array

array

Vstupní pole.

$flags

int

EXTR_OVERWRITE

Určuje, jak jsou ošetřovány kolize a neplatné vstupy.

EXTR_OVERWRITE- Přepíše existující proměnné.
EXTR_SKIP - Nepřepíše existující proměnné.
EXTR_PREFIX_SAME - Předsadí jméno proměnné prefixem v případě, že již existuje.
EXTR_PREFIX_ALL - Předsadí vždy všechny názvy proměnných prefixem.
EXTR_PREFIX_INVALID - Předsadí pouze nevalidní názvy proměnných (např. číselné).
EXTR_IF_EXISTS - Přepíše proměnnou pouze pokud existuje, v ostatních případech nebude proměnná založena. Založením povolených proměnných lze ošetřit vybalení toho správného např. z POST.
EXTR_PREFIX_IF_EXISTS - Předsadí názvy proměnných prefixem v případě, že již existuje. Ty neexistující nebudou vybaleny.
EXTR_REFS - Vybalí proměnné jako reference na původní prvky pole. Tento flag lze kombinovat s ostatními.

$prefix

string

NULL

Třetí, nepovinný parametr je prefix názvu proměnné. Je vyžadován pouze u flagů: EXTR_PREFIX_SAME, EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID nebo EXTR_PREFIX_IF_EXISTS. Za prefix je automaticky přidáno podtržítko ("_").

Návratové hodnoty

Vrací: int

Počet úspěšně vybalených proměnných.

Příklady

<?php
$pole =['a' => 1, 'b' => '2', 'c' => 3.0];

extract($pole);

echo $a;

Funkci extract() lze velmi dobře použít při tvorbě šablon s použitím vlastních struktur PHP.

Související manuály

Aktivity

Nejčastěji vyhledáváné