PHP extract() 函數

文章目錄

• 文法

定義和用法

PHP extract() 函數從數組中把變數匯入到當前的符號表中。

對於數組中的每個元素，鍵名用於變數名，索引值用於變數值。

第二個參數 type 用於指定當某個變數已經存在，而數組中又有同名元素時，extract() 函數如何對待這樣的衝突。

本函數返回成功設定的變數數目。

文法

 extract(array,extract_rules,prefix)
 

參數	描述
array	必需。規定要使用的輸入。
extract_rules	可選。extract() 函數將檢查每個鍵名是否為合法的變數名，同時也檢查和符號表中的變數名是否衝突。 對非法、數字和衝突的鍵名的處理將根據此參數決定。可以是以下值之一： 可能的值： EXTR_OVERWRITE - 預設。如果有衝突，則覆蓋已有的變數。 EXTR_SKIP - 如果有衝突，不覆蓋已有的變數。（忽略數組中同名的元素） EXTR_PREFIX_SAME - 如果有衝突，在變數名前加上首碼 prefix。自 PHP 4.0.5 起，這也包括了對數字索引的處理。 EXTR_PREFIX_ALL - 給所有變數名加上首碼 prefix（第三個參數）。 EXTR_PREFIX_INVALID - 僅在非法或數字變數名前加上首碼 prefix。本標記是 PHP 4.0.5 新加的。 EXTR_IF_EXISTS - 僅在當前符號表中已有同名變數時，覆蓋它們的值。其它的都不處理。可以用在已經定義了一組合法的變數，然後要從一個數組例如 $_REQUEST 中提取值覆蓋這些變數的場合。本標記是 PHP 4.2.0 新加的。 EXTR_PREFIX_IF_EXISTS - 僅在當前符號表中已有同名變數時，建立附加了首碼的變數名，其它的都不處理。本標記是 PHP 4.2.0 新加的。 EXTR_REFS - 將變數作為引用提取。這有力地表明了匯入的變數仍然引用了 var_array 參數的值。可以單獨使用這個標誌或者在 extract_type 中用 OR 與其它任何標誌結合使用。本標記是 PHP 4.3.0 新加的。
prefix	可選。請注意 prefix 僅在 extract_type 的值是 EXTR_PREFIX_SAME，EXTR_PREFIX_ALL，EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS 時需要。如果附加了首碼後的結果不是合法的變數名，將不會匯入到符號表中。 首碼和數組鍵名之間會自動加上一個底線。

例子 1

<?php
$a = 'Original';
$my_array = array("a" => "Cat","b" => "Dog", "c" => "Horse");
extract($my_array);
echo "\$a = $a; \$b = $b; \$c = $c";
?>
 

輸出：

$a = Cat; $b = Dog; $c = Horse
 

例子 2

使用全部參數：

<?php
$a = 'Original';
$my_array = array("a" => "Cat","b" => "Dog", "c" => "Horse");

extract($my_array, EXTR_PREFIX_SAME, 'dup');

echo "\$a = $a; \$b = $b; \$c = $c; \$dup_a = $dup_a;";
?>
 

輸出：

$a = Original; $b = Dog; $c = Horse; $dup_a = Cat;