在 php 中解构对象/关联数组的赋值


Destructuring assignment in php for objects / associative arrays

在CoffeeScript,Clojure,ES6和许多其他语言中,我们对对象/映射/等进行了解构,有点像这样:

obj = {keyA: 'Hello from A', keyB: 'Hello from B'}
{keyA, keyB} = obj

我在 php 中找到了 list 函数,它可以让您像这样解构数组:

$info = array('coffee', 'brown', 'caffeine');
list($drink, $color, $power) = $info;

有没有办法在 PHP 中解构对象或关联数组?如果不在核心库中,也许有人编写了一些智能助手函数?

对于 PHP 7.0 及更低版本,这超出了 list 的功能。文档指出:

list 仅适用于数值数组,并假定数值索引从 0 开始。

可以满足您目的的一件事是将变量从数组导入当前交易品种表中的extract()函数。虽然使用 list 您可以显式定义变量名称,但extract()并没有给您这种自由。

提取关联数组

有了extract你可以做这样的事情:

<?php
$info = [ 'drink' => 'coffee', 'color' => 'brown', 'power' => 'caffeine' ];
extract($info);
var_dump($drink); // string(6) "coffee"
var_dump($color); // string(5) "brown"
var_dump($power); // string(8) "caffeine"

提取对象

提取对象的工作方式几乎相同。由于extract只将数组作为参数,因此我们需要将对象属性作为数组获取。 get_object_vars为你做到这一点。它返回一个关联数组,其中所有公共属性作为键,其值作为值。

<?php
class User {
    public $name = 'Thomas';
}
$user = new User();
extract( get_object_vars($user) );
var_dump($name); // string(6) "Thomas"

陷阱

extract()list不同,因为它不允许您显式定义导出到符号表的变量名称。默认情况下,变量名称与数组键相对应。

  • list是一种语言结构,而extract()是一个函数
  • 可能会
  • 无意中覆盖事先定义的变量
  • 数组键作为变量名称可能无效

使用可以作为第二个参数传递给extract()$flags 参数,您可以在发生冲突或无效变量时影响行为。但是,了解extract()的工作原理并将其与cauton一起使用仍然很重要。

编辑:从PHP 7.1开始,这是可能的:

http://php.net/manual/en/migration71.new-features.php#migration71.new-features.support-for-keys-in-list

您现在可以在 list() 或其新的速记 [] 语法中指定键。这允许解构具有非整数或非顺序键的数组。

https://php.net/manual/en/migration71.new-features.php#migration71.new-features.symmetric-array-destructuring

速记数组语法 ([]) 现在可用于解构赋值的数组(包括在 foreach 中),作为现有 list() 语法的替代方法,该语法仍然受支持。

例如:

$test_arr = ['a' => 1, 'b' => 2];
list('a' => $a, 'b' => $b) = $test_arr;
var_dump($a);
var_dump($b);

将从 7.1.0 开始输出以下内容

int(1) 
int(2)

注意到接受的答案错过了使用速记符号的示例、使用提取的安全问题和 IDE 问题。

数值数组解构 (PHP 7.1)

从 PHP 7.1 开始,支持如下数字数组解构(Symetric 数组解构):

<?php
$data = [55, 'John', 'UK'];
[$id, $name] = $data; // short-hand (recommended)
list($id, $name) = $data; // long-hand

请注意,如果您不想要项目,可能会错过它们。

关联数组解构 (PHP 7.1)

您还可以解构关联数组(支持列表中的键),如下所示:

<?php
$data = ['id' => 55, 'firstName' => 'John', 'country' => 'UK']
['id' => $id, 'firstName' => $name] = $data; // short-hand (recommended)
list('id' => $id, 'firstName' => $name) = $data; // long-hand

请注意,如果您不想要项目,可能会错过它们。此外,变量名称可以与属性名称不同。

对象解构 (PHP 7.1)

不幸的是,没有对象解构。但是,您可以使用 get_object_vars 将对象转换为关联数组,然后使用关联数组解构。

<?php
class User {
    public $id;
    public $name;
    public $country;
}
$user = new User();
$user->id = 55;
$user->name = 'John';
$user->country = 'UK';
['id' => $id, 'name' => $firstName] = get_object_vars($user)

但是,这可能会破坏某些 IDE 功能。以下是我在使用 PHPStorm 2019.1 时注意到的一些问题:

  • IDE 可能不再理解变量的类型,因此您需要添加一些 PHPDoc @var Type以维护自动完成功能
  • 不能很好地与重构工具配合使用。例如,如果重命名其中一个属性,数组解构部分也不会自动重命名。

所以我建议以正常方式进行操作:

$id = $user->id
$name = $user->firstName

请勿使用extract

使用提取时,始终设置所有变量。在那里使用它是一个非常糟糕的主意,因为:

  • 它可能导致安全问题。即使你小心,也可能导致将来出现不明显的安全漏洞。如果您确实使用它,请不要将其与用户输入一起使用(例如 $_GET$_POST),除非你想让恶意黑客的一天。
  • 可能导致难以检测的错误
  • 如果类或数组将来通过引入新属性而更改,如果它与已使用的变量重合,则可能会破坏您的代码,除非您使用 EXTR_SKIP 标志或类似标志

变量变量是实现此目的的一种方法:

$args = ['a' => 1, 'b' => 2, 'c' => 3];
foreach (['a', 'c'] as $v) $$v = $args[$v];
// $a is 1, $b is undefined, $c is 3

真的不漂亮,值得庆幸的是,这已经在 7.1 中由 https://wiki.php.net/rfc/short_list_syntax 解决。这会让你在上面的例子中说['a' => $a, 'c' => $c] = $args;

由于 7.1 包含了一种为您的 var 使用与 assoc 数组键不同的名称的方法。在这里使用变量也非常简单:

foreach (['a' => 'eh', 'b' => 'bee'] as $k => $v) $$v = $args[$k];
// $eh is 1, $bee is 2
一些

开发人员和一些编码风格将$$var定义为类似于直接使用 evalextractGPR魔术变量的反模式。 这是因为使用变量会使代码更难理解,这直接导致错误并阻止静态代码分析工具运行。

如果您确实采用了 $$var ,则改用 ${$var} 形式可能会有所帮助,这很明显作者并没有简单地键入太多的 $,并且可能会在审核他们的代码时避免作者立即的负面反馈。

一个简单的解决方案是将对象读取为数组。因此,假设您使用@Yahya Uddin User对象,您可以这样做:

['id' => $id, 'firstName' => $name] = (array)$user
// $id = 55, name = 'john'

这将告诉 PHP 将此目标读取为关联数组。