(PHP 4, PHP 5, PHP 7, PHP 8)
extract — 从数组中将变量导入到当前的符号表
本函数用来将变量从数组中导入到当前的符号表中。
检查每个键名看是否可以作为一个合法的变量名,同时也检查和符号表中已有的变量名的冲突。
array
一个关联数组。此函数会将键名当作变量名,值作为变量的值。 对每个键/值对都会在当前的符号表中建立变量,并受到 flags
和 prefix
参数的影响。
必须使用关联数组,数字索引的数组将不会产生结果,除非用了 EXTR_PREFIX_ALL
或者 EXTR_PREFIX_INVALID
。
flags
对待非法/数字和冲突的键名的方法将根据取出标记 flags
参数决定。可以是以下值之一:
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
array
参数的值。可以单独使用这个标志或者在 flags
中用 OR 与其它任何标志结合使用。 如果没有指定 flags
,则被假定为 EXTR_OVERWRITE
。
prefix
注意 prefix
仅在 flags
的值是 EXTR_PREFIX_SAME
,EXTR_PREFIX_ALL
,EXTR_PREFIX_INVALID
或 EXTR_PREFIX_IF_EXISTS
时需要。 如果附加了前缀后的结果不是合法的变量名,将不会导入到符号表中。前缀和数组键名之间会自动加上一个下划线。
返回成功导入到符号表中的变量数目。
示例 #1 extract() 例子
extract() 的一种可能用法是将 wddx_deserialize() 返回的结合数组中的内容导入到符号表变量中去。
<?php
$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。
不要对不能信任的数据使用 extract(),例如用户的输入($_GET, $_FILES...)。 如果这样做,要确保使用不会覆盖的 flags
值,例如 EXTR_SKIP
,并且要留意应该按照 variables_order 在 php.ini 里 定义的顺序来提取。