PHP中extract()函数的定义和用法

  定义和用法

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

  对于数组中的每个元素,键名用于变量名,键值用于变量值。

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

  本函数返回成功设置的变量数目。

  语法

  extract(array,extract_rules,prefix)

  

参数 描述
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 时需要。如果附加了前缀后的结果不是合法的变量名,将不会导入到符号表中。

  前缀和数组键名之间会自动加上一个下划线。

例子 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;

  PHP extract() 函数

  

  近日在看一个牛人的代码时,看到一个非常好用的函数:extract(),它的主要作用是将数组展开,键名作为变量名,元素值为变量值,可以说为数组的操作提供了另外一个方便的工具,比方说,可以很方便的提取$_POST或者$_GET的元素,对表单提交上来的内容不能不用一一赋值,直接使用下面代码:

  form.html

  

复制代码 代码如下:

  <form action="action.php" method="post">

  <input type="text" name="username">

  <input type="password" name="password">

  <input type="submit">

  在action.php中只要使用extract()函数将$_POST全局数据解开:

  action.php

  

复制代码 代码如下:

  <?php

  extract($_POST);

  //相当于$username = $_POST['username'];

  //$password = $_POST['password'];

  ?>

  是不是很方便呢?呵呵,下面是PHP手册里的详细解释:

  extract

  (PHP 4, PHP 5)

  extract — 从数组中将变量导入到当前的符号表

  说明

  int extract ( array $var_array [, int $extract_type [, string $prefix ]] )

  本函数用来将变量从数组中导入到当前的符号表中。接受结合数组 var_array 作为参数并将键名当作变量名,值作为变量的值。对每个键/值对都会在当前的符号表中建立变量,并受到 extract_type 和 prefix 参数的影响。

  Note: 自版本 4.0.5 起本函数返回被提取的变量数目。

  Note: EXTR_IF_EXISTS 和 EXTR_PREFIX_IF_EXISTS 是版本 4.2.0 中引进的。

  Note: EXTR_REFS 是版本 4.3.0 中引进的。

  extract() 检查每个键名看是否可以作为一个合法的变量名,同时也检查和符号表中已有的变量名的冲突。对待非法/数字和冲突的键名的方法将根据 extract_type 参数决定。可以是以下值之一:

  EXTR_OVERWRITE

  如果有冲突,覆盖已有的变量。

  EXTR_SKIP

  如果有冲突,不覆盖已有的变量。

  EXTR_PREFIX_SAME

  如果有冲突,在变量名前加上前缀 prefix 。

  EXTR_PREFIX_ALL

  给所有变量名加上前缀 prefix 。自 PHP 4.0.5 起这也包括了对数字索引的处理。

  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 新加的。

  如果没有指定 extract_type ,则被假定为 EXTR_OVERWRITE。

  注意 prefix 仅在 extract_type 的值是 EXTR_PREFIX_SAME,EXTR_PREFIX_ALL,EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS 时需要。如果附加了前缀后的结果不是合法的变量名,将不会导入到符号表中。前缀和数组键名之间会自动加上一个下划线。

  extract() 返回成功导入到符号表中的变量数目。

  Warning

  不要对不能信任的数据使用 extract(),例如用户的输入($_GET,…)。如果这样做,举例说,要临时运行依赖于 register_globals 的老代码,要确保使用不会覆盖的 extract_type 值,例如 EXTR_SKIP,并且要留意应该按照 php.ini 中由 variables_order 定义的顺序来提取。

  extract() 的一种可能用法是将 wddx_deserialize() 返回的结合数组中的内容导入到符号表变量中去。

  Example#1 extract() 例子

  

复制代码 代码如下:

  <?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_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。

  必须使用关联数组,数字索引的数组将不会产生结果,除非用了 EXTR_PREFIX_ALL 或者 EXTR_PREFIX_INVALID。