PHP extract() 函式是从数组中把变数导入到当前的符号表中。
基本介绍
- 中文名:extract
- 别名:参数
- 职业:成功设定
- 毕业院校:本函式
- 信仰:变数值
- 主要成就:PHP extract() 函式从数组中把变数导入到当前的符号表中
- 代表作品:函式
定义和用法
对于数组中的每个元素,键名用于变数名,键值用于变数值。
第二个参数 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; |