本函数用来将变量从数组中导入到当前的符号表中。接受结合数组 var_array 作为参数并将键名当作变量名,值作为变量的值。对每个键/值对都会在当前的符号表中建立变量,并受到 extract_type 和 prefix 参数的影响。
自版本 4.0.5 起本函数返回被提取的变量数目。
EXTR_IF_EXISTS
和
EXTR_PREFIX_IF_EXISTS
是版本 4.2.0 中引进的。
EXTR_REFS
是版本 4.3.0 中引进的。
extract() 检查每个键名看是否可以作为一个合法的变量名,同时也检查和符号表中已有的变量名的冲突。对待非法/数字和冲突的键名的方法将根据 extract_type 参数决定。可以是以下值之一:
EXTR_OVERWRITE
EXTR_SKIP
EXTR_PREFIX_SAME
EXTR_PREFIX_ALL
EXTR_PREFIX_INVALID
EXTR_IF_EXISTS
EXTR_PREFIX_IF_EXISTS
EXTR_REFS
如果没有指定 extract_type,则被假定为 EXTR_OVERWRITE
。
注意 prefix 仅在
extract_type 的值是
EXTR_PREFIX_SAME
,EXTR_PREFIX_ALL
,EXTR_PREFIX_INVALID
或 EXTR_PREFIX_IF_EXISTS
时需要。如果附加了前缀后的结果不是合法的变量名,将不会导入到符号表中。前缀和数组键名之间会自动加上一个下划线。
extract() 返回成功导入到符号表中的变量数目。
不要对不能信任的数据使用
extract(),例如用户的输入($_GET,...)。如果这样做,举例说,要临时运行依赖于
register_globals
的老代码,要确保使用不会覆盖的
extract_type 值,例如
EXTR_SKIP
,并且要留意应该按照
php.ini
中由 variables_order
定义的顺序来提取。
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
。
必须使用关联数组,数字索引的数组将不会产生结果,除非用了
EXTR_PREFIX_ALL
或者 EXTR_PREFIX_INVALID
。
参见 compact()。