extract
(PHP 4, PHP 5)
extract — 从数组中将变量导入到当前的符号表
说明
int extract
( array &$var_array
[, int $extract_type
= EXTR_OVERWRITE
[, string $prefix
= NULL
]] )
本函数用来将变量从数组中导入到当前的符号表中。
检查每个键名看是否可以作为一个合法的变量名,同时也检查和符号表中已有的变量名的冲突。
参数
var_array
一个关联数组。此函数会将键名当作变量名,值作为变量的值。
对每个键/值对都会在当前的符号表中建立变量,并受到
extract_type
和 prefix
参数的影响。
必须使用关联数组,数字索引的数组将不会产生结果,除非用了
EXTR_PREFIX_ALL
或者 EXTR_PREFIX_INVALID
。
extract_type
对待非法/数字和冲突的键名的方法将根据
extract_type
参数决定。可以是以下值之一:
EXTR_OVERWRITE
如果有冲突,覆盖已有的变量。
EXTR_SKIP
如果有冲突,不覆盖已有的变量。
EXTR_PREFIX_SAME
如果有冲突,在变量名前加上前缀 prefix
。
EXTR_PREFIX_ALL
给所有变量名加上前缀
prefix
。
EXTR_PREFIX_INVALID
仅在非法/数字的变量名前加上前缀 prefix
。
EXTR_IF_EXISTS
仅在当前符号表中已有同名变量时,覆盖它们的值。其它的都不处理。
举个例子,以下情况非常有用:定义一些有效变量,然后从 $_REQUEST 中仅导入这些已定义的变量。
EXTR_PREFIX_IF_EXISTS
仅在当前符号表中已有同名变量时,建立附加了前缀的变量名,其它的都不处理。
EXTR_REFS
将变量作为引用提取。这有力地表明了导入的变量仍然引用了
var_array
参数的值。可以单独使用这个标志或者在
extract_type
中用 OR 与其它任何标志结合使用。
如果没有指定 extract_type
,则被假定为 EXTR_OVERWRITE
。
prefix
注意 prefix
仅在
extract_type
的值是
EXTR_PREFIX_SAME
,EXTR_PREFIX_ALL
,EXTR_PREFIX_INVALID
或 EXTR_PREFIX_IF_EXISTS
时需要。
如果附加了前缀后的结果不是合法的变量名,将不会导入到符号表中。前缀和数组键名之间会自动加上一个下划线。
返回值
返回成功导入到符号表中的变量数目。
更新日志
版本
说明
4.3.0
增加了 EXTR_REFS
。
4.2.0
引进 EXTR_IF_EXISTS
和 EXTR_PREFIX_IF_EXISTS
。
4.0.5
函数可以返回被提取的变量数目。
增加了 EXTR_PREFIX_INVALID
。
从这时起 EXTR_PREFIX_ALL
也包括了对数字索引的处理。
范例
Example #1 extract() 例子
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_sizen";
?>
以上例程会输出:
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。
注释
Warning
不要对不能信任的数据使用
extract(),例如用户的输入($_GET, $_FILES,...)。如果这样做,举例说,要临时运行依赖于
register_globals
的老代码,要确保使用不会覆盖的
extract_type
值,例如
EXTR_SKIP
,并且要留意应该按照 variables_order 在 php.ini 里
定义的顺序来提取。
Note:
If you
have register_globals
turned on and you use extract()
on $_FILES and
specify EXTR_SKIP
, you may be surprised at
the results.
This is not recommended practice and is only documented here for completeness. The use of register_globals is deprecated and calling extract() on untrusted data such as $_FILES is, as noted above, a potential security risk. If you encounter this issue, it means that you are using at least two poor coding practices.
<?phpYou might expect to see something like the following:
/* Suppose that $testfile is the name of a file upload input
and that register_globals is turned on. */
var_dump($testfile);
extract($_FILES, EXTR_SKIP);
var_dump($testfile);
var_dump($testfile['tmp_name']);
?>
string(14) "/tmp/phpgCCPX8" array(5) { ["name"]=> string(10) "somefile.txt" ["type"]=> string(24) "application/octet-stream" ["tmp_name"]=> string(14) "/tmp/phpgCCPX8" ["error"]=> int(0) ["size"]=> int(4208) } string(14) "/tmp/phpgCCPX8"However, you would instead see something like this:
string(14) "/tmp/phpgCCPX8" string(14) "/tmp/phpgCCPX8" string(1) "/"
This is due to the fact that
since register_globals is
turned on, $testfile already exists in the
global scope when extract() is called. And
since EXTR_SKIP
is
specified, $testfile is not overwritten with
the contents of the $_FILES
array
so $testfile remains a string.
Because strings may
be accessed using array syntax and the non-numeric string
tmp_name is interpreted
as 0, PHP
sees $testfile['tmp_name']
as $testfile[0].
参见
compact() - 建立一个数组,包括变量名和它们的值 list() - 把数组中的值赋给一些变量