1. 首页
  2. PHP 菜鸟教程
  3. PHP - extract() 函数

PHP - extract() 函数

语法


extract($array, $extract_type, $prefix)

定义与用法

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

该函数使用数组键名作为变量名，使用数组键值作为变量值。针对数组中的每个元素，将在当前符号表中创建对应的一个变量。

第二个参数 type 用于指定当某个变量已经存在，而数组中又有同名元素时，extract() 函数如何对待这样的冲突。

该函数返回成功导入到符号表中的变量数目。

参数

参数 描述
array （必填）指定一个数组
extract_type

（可选）
extract() 函数检查无效变量名及与现有变量名的碰撞。该参数指定了无效和碰撞名称的处理方式，可能的值：

  • 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 − 将变量作为引用提取。导入的变量仍然引用了数组参数的值。
prefix （可选）
如果 extract_rules 参数是 EXTR_PREFIX_SAME、EXTR_PREFIX_ALL、EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS，则需要指定前缀 prefix。
如果附加了前缀后的结果不是合法的变量名，将不会导入到符号表中。前缀和数组键名之间会自动加上一个下划线。

返回值

返回成功导入到符号表的变量数量。

示例

试试以下示例：


<?php
   $size = "large";
   $input = array("color" => "blue", "size"  => "medium", "shape" => "sphere");
   extract($input, EXTR_PREFIX_SAME, "bbcx");
   echo "$color, $size, $shape, $bbcx_size";
?>

这将得到以下结果：

blue, large, sphere, medium
<< PHP - end() 函数 PHP - in_array() 函数 >>