将对象转换为数组 - 调用的任何魔术方法


Casting object to array - any magic method being called?

我有一个类Foo的对象:

class Foo extends Bar {
    protected $a;
    protected $b;
}
$obj = new Foo();

我想要(并且必须)做的是将此对象转换为数组,如下所示:

$arr = (array)$obj;

目前有没有被调用的魔法(或不是魔法:))方法?还是有其他方法可以拦截它?我知道我可以写一个简单的方法,例如。 asArray() Foo 中,但我正在寻找一些更"原生"的 PHP 方式。

PHP 中没有__toArray神奇的方法。2006年,一项优化建议被否决,答案如下:

[2006-08-20 11:12 UTC] helly@php.net

为什么不简单地有一个方法 asArray() 甚至可能作为一个 接口:

interface ArrayConversion { function asArray(); }

看,我们有__toString,因为它在语言结构中得到支持,例如 回显、打印等内部功能。但我们决定反对 已经自动转换了数组。所以它永远不会在任何 语言构造。也就是说,没有必要这样做,也没有什么 您将战胜上述界面。事实上你会做到的 PHP更复杂,因为你只会再添加一个神奇的功能。

因此,它不太可能在任何未来的版本中实现(如果您问我,这很遗憾)。

您可以让该类实现 ArrayAccess 接口。 这将允许您将对象视为数组而不进行强制转换,并且您可以完全控制成员的使用方式。

可悲的是,不,投射到数组不会触发任何魔术方法,就像它所做的那样:

$s = (string)$obj;

哪些触发器__toString()方法以及您可以重写的方法。

但是,您可以编写自定义toArray()方法。

您可能还对 Serializable 接口感兴趣,该接口允许您编写自定义序列化程序策略。

不确定这个问题是否仍然相关,但 php 内置了 ArrayObject 类,它允许将对象视为数组,并且在用作数据库记录或集合的容器时会很方便。

对于严格类型,这可能不是最佳实践,但它允许将对象视为数组,并且这两个语句都是有效的。

$obj = new ArrayObject(['a' => 'alpha']);
var_dump($obj['a']); //alpha
var_dump($obj->getOffset('a'));//alpha

但是,您需要记住ArrayObject的行为

$obj = new ArrayObject(['a' => 'alpha']);
//Access Property
var_dump($obj['a']); //alpha
var_dump($obj->offsetGet('a'));//alpha
var_dump($obj->a); //null Notice: Undefined property: ArrayObject::$a
//Serialization
var_dump(serialize($obj));// string 'C:11:"ArrayObject":41:{x:i:0;a:1:{s:1:"a";s:5:"alpha";};m:a:0:{}}' (length=65)
var_dump($obj->serialize());// string 'x:i:0;a:1:{s:1:"a";s:5:"alpha";};m:a:0:{}'
var_dump(serialize($obj) === $obj->serialize());// false !!!
//Setting Properties
$obj['b'] = 'beta'; //OK
$obj->c = 'gamma'; //value becomes object property!!!
var_dump($obj);
/* OBJECT DUMP
object(ArrayObject)[13]
  public 'c' => string 'gamma' (length=5)
  private 'storage' =>
    array (size=2)
      'a' => string 'alpha' (length=5)
      'b' => string 'beta' (length=4)
 */
//Property validation as array
var_dump(isset($obj['a']));//true
var_dump(isset($obj['b']));//true
var_dump(isset($obj['c']));//false
//Property validation as object
var_dump(isset($obj->a));//false
var_dump(isset($obj->b));//false
var_dump(isset($obj->c));//true
//Typecasting
var_dump((array)$obj);
/*
array (size=2)
  'a' => string 'alpha' (length=5)
  'b' => string 'beta' (length=4)
 */
//var_dump((string)$obj);// Catchable fatal error: Object of class ArrayObject could not be converted to string

ArrayObject 接受两个标志ArrayObject::STD_PROP_LIST作为默认值,ArrayObject::ARRAY_AS_PROPS作为替代标志。

这将改变读取值的行为,但不支持以这种方式设置新属性,下面是示例:

$obj = new ArrayObject(['a' => 'alpha'], ArrayObject::ARRAY_AS_PROPS);
//Access Property
var_dump($obj['a']); //alpha
var_dump($obj->offsetGet('a'));//alpha
var_dump($obj->a);//alpha
//Serialization
var_dump(serialize($obj));// string 'C:11:"ArrayObject":41:{x:i:0;a:1:{s:1:"a";s:5:"alpha";};m:a:0:{}}' (length=65)
var_dump($obj->serialize());// string 'x:i:0;a:1:{s:1:"a";s:5:"alpha";};m:a:0:{}'
var_dump(serialize($obj) === $obj->serialize());// false !!!
//Setting Properties
$obj['b'] = 'beta'; //OK
$obj->c = 'gamma'; //OK
var_dump($obj);
/* OBJECT DUMP
object(ArrayObject)[14]
  private 'storage' =>
    array (size=3)
      'a' => string 'alpha' (length=5)
      'b' => string 'beta' (length=4)
      'c' => string 'gamma' (length=5)
 */
//Property validation as array
var_dump(isset($obj['a']));//true
var_dump(isset($obj['b']));//true
var_dump(isset($obj['c']));//false !!!
//Property validation as object
var_dump(isset($obj->a));//true
var_dump(isset($obj->b));//true
var_dump(isset($obj->c));//true
//Typecasting
var_dump((array)$obj);
/*
array (size=2)
  'a' => string 'alpha' (length=5)
  'b' => string 'beta' (length=4)
 */

为了使这种行为更加一致,你必须扩展这个类并实现魔术方法__get()__set()__isset()__unset()

另一个棘手的部分是序列化,默认方法serialize会返回一个副本序列化$storage变量而不是对象本身,作为返回实例序列化副本的解决方法,您可以在__toString方法中实现默认序列化,这样它的行为正确。

class FooObject extends ArrayObject
{
    public function __get($index)
    {
        if ($this->offsetExists($index)) {
            return $this->offsetGet($index);
        } else {
            throw new UnexpectedValueException('Undefined key ' . $index);
        }
    }
    public function __set($index, $value)
    {
        $this->offsetSet($index, $value);
        return $this;
    }
    public function __isset($index)
    {
        return $this->offsetExists($index);
    }
    public function __unset($index)
    {
        return $this->offsetUnset($index);
    }
    public function __toString()
    {
        return serialize($this);
    }
}

使用示例

$obj2 = new FooObject(['a' => 'alpha']);
//Access Property
var_dump($obj2['a']); //alpha
var_dump($obj2->offsetGet('a'));//alpha
var_dump($obj2->a); //alpha
//Serialization
var_dump(serialize($obj));// string 'C:11:"ArrayObject":41:{x:i:0;a:1:{s:1:"a";s:5:"alpha";};m:a:0:{}}' (length=65)
var_dump($obj->serialize());// string 'x:i:0;a:1:{s:1:"a";s:5:"alpha";};m:a:0:{}'
var_dump(serialize($obj) === $obj->serialize());// false !!!
//Setting Properties
$obj2['b'] = 'beta'; //OK
$obj2->c = 'gamma'; //OK
var_dump($obj2);
/* OBJECT DUMP
object(FooObject)[14]
  private 'storage' (ArrayObject) =>
    array (size=3)
      'a' => string 'alpha' (length=5)
      'b' => string 'beta' (length=4)
      'c' => string 'gamma' (length=5)
 */
//Property validation as array
var_dump(isset($obj2['a']));//true
var_dump(isset($obj2['b']));//true
var_dump(isset($obj2['c']));//true
//Property validation as object
var_dump(isset($obj2->a));//true
var_dump(isset($obj2->b));//true
var_dump(isset($obj2->c));//true
//Typecasting
var_dump((array)$obj2);
/*
array (size=3)
  'a' => string 'alpha' (length=5)
  'b' => string 'beta' (length=4)
  'c' => string 'gamma' (length=5)
 */

在不更改原始类定义的情况下执行此操作的一种方法是使用反射。这允许您在运行时检查类的属性。

摘自手册:http://www.php.net/manual/en/reflectionclass.getproperties.php

<?php
class Foo {
    public    $foo  = 1;
    protected $bar  = 2;
    private   $baz  = 3;
}
$foo = new Foo();
$reflect = new ReflectionClass($foo);
$props   = $reflect->getProperties(ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED);
foreach ($props as $prop) {
    print $prop->getName() . "'n";
}
var_dump($props);
?>
The above example will output something similar to:
foo
bar
array(2) {
  [0]=>
  object(ReflectionProperty)#3 (2) {
    ["name"]=>
    string(3) "foo"
    ["class"]=>
    string(3) "Foo"
  }
  [1]=>
  object(ReflectionProperty)#4 (2) {
    ["name"]=>
    string(3) "bar"
    ["class"]=>
    string(3) "Foo"
  }
}
您可以使用

get_object_vars($yourObject) 返回可从上下文访问的所有属性名称/值的关联数组。

见 http://php.net/manual/en/function.get-object-vars.php

如果你想访问受保护的或私有的属性,我的建议是扩展ArrayObject,它实现了getArrayCopy()的方法