PHP extract() 函數

PHP Array Reference完整的 PHP Array 參考手冊

實例

將鍵值 "Cat"、"Dog" 和 "Horse" 賦值給變數 $a、$b 和 $c：

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

定義和用法

extract() 函數從數組中將變數導入到當前的符號表。

該函數使用數組鍵名作為變數名，使用數組鍵值作為變數值。針對數組中的每個元素，將在當前符號表中創建對應的一個變數。

該函數返回成功設置的變數數目。

語法

extract(array,extract_rules,prefix)

參數 描述
array 必需。規定要使用的數組。
extract_rules 可選。extract() 函數將檢查每個鍵名是否為合法的變數名，同時也檢查和符號表中已存在的變數名是否衝突。對不合法和衝突的鍵名的處理將根據此參數決定。

可能的值：

  • EXTR_OVERWRITE - 默認。如果有衝突，則覆蓋已有的變數。
  • EXTR_SKIP - 如果有衝突，不覆蓋已有的變數。
  • EXTR_PREFIX_SAME - 如果有衝突，在變數名前加上首碼 prefix。
  • EXTR_PREFIX_ALL - 給所有變數名加上首碼 prefix。
  • EXTR_PREFIX_INVALID - 僅在不合法或數字變數名前加上首碼 prefix。
  • EXTR_IF_EXISTS - 僅在當前符號表中已有同名變數時，覆蓋它們的值。其他的都不處理。
  • EXTR_PREFIX_IF_EXISTS - 僅在當前符號表中已有同名變數時，建立附加了首碼的變數名，其他的都不處理。
  • EXTR_REFS - 將變數作為引用提取。導入的變數仍然引用了數組參數的值。
prefix 可選。如果 extract_rules 參數的值是 EXTR_PREFIX_SAME、EXTR_PREFIX_ALL、 EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS，則 prefix 是必需的。

該參數規定了首碼。首碼和數組鍵名之間會自動加上一個下劃線。

技術細節

返回值： 返回成功設置的變數數目。
PHP 版本： 4+
更新日誌： extract_rules 的值 EXTR_REFS 是在 PHP 4.3 中新增的。

extract_rules 的值 EXTR_IF_EXISTS 和 EXTR_PREFIX_IF_EXISTS 是在 PHP 4.2 中新增的。

自 PHP 4.0.5 起，該函數返回成功設置的變數數目。

extract_rules 的值 EXTR_PREFIX_INVALID 是在 PHP 4.0.5 中新增的。

自 PHP 4.0.5 起，extract_rules 的值 EXTR_PREFIX_ALL 也包含數字變數。

更多實例

實例 1

使用所有的參數：

<?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";
?>


PHP Array Reference完整的 PHP Array 參考手冊