extract

(PHP 4, PHP 5, PHP 7, PHP 8)

extract — 從數(shù)組中將變量導(dǎo)入到當(dāng)前的符號表

說明

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

本函數(shù)用來將變量從數(shù)組中導(dǎo)入到當(dāng)前的符號表中。

檢查每個鍵名看是否可以作為一個合法的變量名，同時也檢查和符號表中已有的變量名的沖突。

警告

不要對不可信的數(shù)據(jù)使用 extract()，類似用戶輸入 （例如 $_GET、$_FILES）。

參數(shù)

array

一個關(guān)聯(lián)數(shù)組。此函數(shù)會將鍵名當(dāng)作變量名，值作為變量的值。 對每個鍵／值對都會在當(dāng)前的符號表中建立變量，并受到 flags 和 prefix 參數(shù)的影響。

必須使用關(guān)聯(lián)數(shù)組，數(shù)字索引的數(shù)組將不會產(chǎn)生結(jié)果，除非用了 EXTR_PREFIX_ALL 或者 EXTR_PREFIX_INVALID。

flags

對待非法／數(shù)字和沖突的鍵名的方法將根據(jù)取出標(biāo)記 flags 參數(shù)決定。可以是以下值之一：

EXTR_OVERWRITE
如果有沖突，覆蓋已有的變量。
EXTR_SKIP
如果有沖突，不覆蓋已有的變量。
EXTR_PREFIX_SAME
如果有沖突，在變量名前加上前綴 prefix。
EXTR_PREFIX_ALL
給所有變量名加上前綴 prefix。
EXTR_PREFIX_INVALID
僅在非法／數(shù)字的變量名前加上前綴 prefix。
EXTR_IF_EXISTS
僅在當(dāng)前符號表中已有同名變量時，覆蓋它們的值。其它的都不處理。 舉個例子，以下情況非常有用：定義一些有效變量，然后從 $_REQUEST 中僅導(dǎo)入這些已定義的變量。
EXTR_PREFIX_IF_EXISTS
僅在當(dāng)前符號表中已有同名變量時，建立附加了前綴的變量名，其它的都不處理。
EXTR_REFS
將變量作為引用提取。這有力地表明了導(dǎo)入的變量仍然引用了 array 參數(shù)的值。可以單獨(dú)使用這個標(biāo)志或者在 flags 中用 OR 與其它任何標(biāo)志結(jié)合使用。

如果沒有指定 flags，則被假定為 EXTR_OVERWRITE。

prefix

注意 prefix 僅在 flags 的值是 EXTR_PREFIX_SAME，EXTR_PREFIX_ALL，EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS 時需要。 如果附加了前綴后的結(jié)果不是合法的變量名，將不會導(dǎo)入到符號表中。前綴和數(shù)組鍵名之間會自動加上一個下劃線。

返回值

返回成功導(dǎo)入到符號表中的變量數(shù)目。

范例

示例 #1 extract() 例子

extract() 的一種可能用法是將 wddx_deserialize() 返回的結(jié)合數(shù)組中的內(nèi)容導(dǎo)入到符號表變量中去。

<?php

/* 假定 $var_array 是 wddx_deserialize 返回的數(shù)組*/

$size = "large";
$var_array = array("color" => "blue",
                   "size"  => "medium",
                   "shape" => "sphere");
extract($var_array, EXTR_PREFIX_SAME, "wddx");

echo "$color, $size, $shape, $wddx_size\n";

?>

以上例程會輸出：

blue, large, sphere, medium

$size 沒有被覆蓋，因?yàn)橹付? EXTR_PREFIX_SAME，這使得 $wddx_size 被建立。如果指定了 EXTR_SKIP，則 $wddx_size 也不會被建立。EXTR_OVERWRITE 將使 $size 的值為“medium”，EXTR_PREFIX_ALL 將建立新變量 $wddx_color，$wddx_size 和 $wddx_shape。

注釋

警告

不要對不能信任的數(shù)據(jù)使用 extract()，例如用戶的輸入（$_GET， $_FILES...）。 如果這樣做，要確保使用不會覆蓋的 flags 值，例如 EXTR_SKIP，并且要留意應(yīng)該按照 variables_order 在 php.ini 里 定義的順序來提取。

參見

  • compact() - 建立一個數(shù)組，包括變量名和它們的值
  • list() - 把數(shù)組中的值賦給一組變量