定義和用法
對於數組中的每個元素,鍵名用於變數名,鍵值用於變數值。
第二個參數 type 用於指定當某個變數已經存在,而數組中又有同名元素時,extract() 函式如何對待這樣的衝突。
本函式返回成功設定的變數數目。
語法
參數 | 描述 |
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 時需要。如果附加了前綴後的結果不是合法的變數名,將不會導入到符號表中。 前綴和數組鍵名之間會自動加上一個下劃線。 |
可用值
類型 | 意義 |
EXTR_OVERWRITE | 當發生衝突是覆蓋已有變數 |
EXTR_SKIP | 當發生衝突時跳過一個元素 |
EXTR_PREFIX_SAME | 當發生衝突時創建一個名為$prefix_key的變數。必須提供prefix參數 |
EXTR_PREFIX_ALL | 在所有變數的名稱之前加上由prefix參數的指定值。必須提供prefix參數 |
EXTR_PREFIX_INVALID | 使用指定的prefix在可能無效的變數名稱之前加上前綴(例如,數字變數的名稱。)必須提供prefix參數 |
EXTR_IF_EXISTS | 知識提取存在的變數(也就是,用數組中的值覆蓋已有的變數值)。這個參數對於數組到變數的轉換時非常有用,例如,$_REQUEST到一個有效的變數集合的轉換 |
EXTR_PREFIX_IF_EXISTS | 只有在不帶前綴的變數存在的情況下,創建帶有前綴的變數。這個值是在4.2.0版本中新增加的 |
EXTR_REFS | 已飲用方式提取變數 |
例子 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; |