extract
(PHP 4, PHP 5, PHP 7, PHP 8)
extract — 從陣列中將變數匯入到目前的符號表
說明
&$array, int $flags = EXTR_OVERWRITE, string $prefix = ""): int本函式用來將變數從陣列中匯入到目前的符號表中。
檢查每個鍵名看是否可以作為一個合法的變數名，同時也檢查和符號表中已有的變數名的衝突。
參數
-
array -
一個關聯陣列。此函式會將鍵名當作變數名，值作為變數的值。 對每個鍵／值對都會在目前的符號表中建立變數，並受到
flags和prefix參數的影響。必須使用關聯陣列，數字索引的陣列將不會產生結果，除非用了
EXTR_PREFIX_ALL或者EXTR_PREFIX_INVALID。 -
flags -
對待非法／數字和衝突的鍵名的方法將根據取出標記
flags參數決定。可以是以下值之一：-
EXTR_OVERWRITE - 如果有衝突，覆蓋已有的變數。
-
EXTR_SKIP - 如果有衝突，不覆蓋已有的變數。
-
EXTR_PREFIX_SAME -
如果有衝突，在變數名前加上字首
prefix。 -
EXTR_PREFIX_ALL -
給所有變數名加上字首
prefix。 -
EXTR_PREFIX_INVALID -
僅在非法／數字的變數名前加上字首
prefix。 -
EXTR_IF_EXISTS - 僅在目前符號表中已有同名變數時，覆蓋它們的值。其它的都不處理。 舉個例子，以下情況非常有用：定義一些有效變數，然後從 $_REQUEST 中僅匯入這些已定義的變數。
-
EXTR_PREFIX_IF_EXISTS - 僅在目前符號表中已有同名變數時，建立附加了字首的變數名，其它的都不處理。
-
EXTR_REFS -
將變數作為引用提取。這有力地表明瞭匯入的變數仍然引用了
array參數的值。可以單獨使用這個標誌或者在flags中用 OR 與其它任何標誌結合使用。
如果沒有指定
flags，則被假定為EXTR_OVERWRITE。 -
-
prefix -
注意
prefix僅在flags的值是EXTR_PREFIX_SAME，EXTR_PREFIX_ALL，EXTR_PREFIX_INVALID或EXTR_PREFIX_IF_EXISTS時需要。 如果附加了字首后的結果不是合法的變數名，將不會匯入到符號表中。字首和陣列鍵名之間會自動加上一個下劃線。
返回值
返回成功匯入到符號表中的變數數目。
範例
示例 #1 extract() 例子
extract() 的一種可能用法是將 wddx_deserialize() 返回的結合陣列中的內容匯入到符號表變數中去。
<?php
/* 假定 $var_array 是 wddx_deserialize 返回的陣列*/
$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 沒有被覆蓋，因為指定了
EXTR_PREFIX_SAME，這使得 $wddx_size
被建立。如果指定了 EXTR_SKIP，則 $wddx_size
也不會被建立。EXTR_OVERWRITE 將使 $size
的值為「medium」，EXTR_PREFIX_ALL 將建立新變數
$wddx_color，$wddx_size 和
$wddx_shape。
註釋
不要對不能信任的數據使用
extract()，例如使用者的輸入（$_GET， $_FILES...）。
如果這樣做，要確保使用不會覆蓋的
flags 值，例如
EXTR_SKIP，並且要留意應該按照
variables_order
在 php.ini 里
定義的順序來提取。