PHP extract() 函数 - PHP 5 函数参考手册

PHP extract() 函数从数组中将变量导入到当前的符号表

( PHP >= 4 )

函数原型

extract( array,extract_rules,prefix )

该函数使用数组键名作为变量名，使用数组键值作为变量值

针对数组中的每个元素，将在当前符号表中创建对应的一个变量

参数

参数	描述
array	必需。要导出的数组
extract_rules	可选。extract() 函数将检查每个键名是否为合法的变量名，同时也检查和符号表中已存在的变量名是否冲突。对不合法和冲突的键名的处理将根据此参数决定
prefix	可选。设置前缀。前缀和数组键名之间会自动加上一个下划线如果 extract_rules 参数的值是 EXTR_PREFIX_SAME EXTR_PREFIX_ALL EXTR_PREFIX_INVALID EXTR_PREFIX_IF_EXISTS，则 prefix 是必需的

参数 extract_rules 的可能值

值	说明
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	将变量作为引用提取。导入的变量仍然引用了数组参数的值

返回值

返回成功设置的变量数目

更新日志

PHP 版本	更新说明
PHP 4.3	添加参数 extract_rules 的值 EXTR_REFS
PHP 4.2	添加 EXTR_IF_EXISTS 和 EXTR_PREFIX_IF_EXISTS
PHP 4.0.5	该函数返回成功设置的变量数目添加参数 extract_rules 的值 EXTR_PREFIX_INVALID EXTR_PREFIX_ALL 也包含数字变量

范例

将键值 "Cat"、"Dog" 和 "Horse" 赋值给变量 $a、$b 和 $c

<?php

$a = "Original";
$my_array = array("a" => "Cat","b" => "Dog", "c" => "Horse");

extract($my_array);

echo "$a = $a; $b = $b; $c = $c";

运行范例 »

运行以上 PHP 范例，输出结果如下

Cat = Cat; Dog = Dog; Horse = 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";?>

运行范例 »

运行以上 PHP 范例，输出结果如下

Original = Original; Dog = Dog; Horse = Horse; Cat = Cat