定義和用法
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;
PHP extract() 函數
近日在看一個牛人的代碼時,看到一個非常好用的函數:extract(),它的主要作用是將數組展開,鍵名作為變量名,元素值為變量值,可以說為數組的操作提供了另外一個方便的工具,比方說,可以很方便的提取$_POST或者$_GET的元素,對表單提交上來的內容不能不用一一賦值,直接使用下面代碼:
form.html
復制代碼 代碼如下:
<form action="action.php" method="post">
<input type="text" name="username">
<input type="password" name="password">
<input type="submit">
在action.php中只要使用extract()函數將$_POST全局數據解開:
action.php
復制代碼 代碼如下:
<?php
extract($_POST);
//相當於$username = $_POST['username'];
//$password = $_POST['password'];
?>
是不是很方便呢?呵呵,下面是PHP手冊裡的詳細解釋:
extract
(PHP 4, PHP 5)
extract — 從數組中將變量導入到當前的符號表
說明
int extract ( array $var_array [, int $extract_type [, string $prefix ]] )
本函數用來將變量從數組中導入到當前的符號表中。接受結合數組 var_array 作為參數並將鍵名當作變量名,值作為變量的值。對每個鍵/值對都會在當前的符號表中建立變量,並受到 extract_type 和 prefix 參數的影響。
Note: 自版本 4.0.5 起本函數返回被提取的變量數目。
Note: EXTR_IF_EXISTS 和 EXTR_PREFIX_IF_EXISTS 是版本 4.2.0 中引進的。
Note: EXTR_REFS 是版本 4.3.0 中引進的。
extract() 檢查每個鍵名看是否可以作為一個合法的變量名,同時也檢查和符號表中已有的變量名的沖突。對待非法/數字和沖突的鍵名的方法將根據 extract_type 參數決定。可以是以下值之一:
EXTR_OVERWRITE
如果有沖突,覆蓋已有的變量。
EXTR_SKIP
如果有沖突,不覆蓋已有的變量。
EXTR_PREFIX_SAME
如果有沖突,在變量名前加上前綴 prefix 。
EXTR_PREFIX_ALL
給所有變量名加上前綴 prefix 。自 PHP 4.0.5 起這也包括了對數字索引的處理。
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 新加的。
如果沒有指定 extract_type ,則被假定為 EXTR_OVERWRITE。
注意 prefix 僅在 extract_type 的值是 EXTR_PREFIX_SAME,EXTR_PREFIX_ALL,EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS 時需要。如果附加了前綴後的結果不是合法的變量名,將不會導入到符號表中。前綴和數組鍵名之間會自動加上一個下劃線。
extract() 返回成功導入到符號表中的變量數目。
Warning
不要對不能信任的數據使用 extract(),例如用戶的輸入($_GET,…)。如果這樣做,舉例說,要臨時運行依賴於 register_globals 的老代碼,要確保使用不會覆蓋的 extract_type 值,例如 EXTR_SKIP,並且要留意應該按照 php.ini 中由 variables_order 定義的順序來提取。
extract() 的一種可能用法是將 wddx_deserialize() 返回的結合數組中的內容導入到符號表變量中去。
Example#1 extract() 例子
復制代碼 代碼如下:
<?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。
必須使用關聯數組,數字索引的數組將不會產生結果,除非用了 EXTR_PREFIX_ALL 或者 EXTR_PREFIX_INVALID。