将PHP对象转换为关联数组


760

我正在将API集成到我的网站,该网站可以使用数组编写代码时处理存储在对象中的数据。

我想要一个快捷方式将对象转换为数组的函数。

Answers:


1392

只是打字

$array = (array) $yourObject;

数组

如果将对象转换为数组,则结果是一个数组,其元素是对象的属性。键是成员变量名称,但有一些值得注意的例外:整数属性不可访问;私有变量的类名在变量名之前;受保护的变量在变量名前带有“ *”。这些前置值的任一侧都有空字节。

示例:简单对象

$object = new StdClass;
$object->foo = 1;
$object->bar = 2;

var_dump( (array) $object );

输出:

array(2) {
  'foo' => int(1)
  'bar' => int(2)
}

示例:复杂对象

class Foo
{
    private $foo;
    protected $bar;
    public $baz;

    public function __construct()
    {
        $this->foo = 1;
        $this->bar = 2;
        $this->baz = new StdClass;
    }
}

var_dump( (array) new Foo );

输出(为清晰起见,已编辑\ 0s):

array(3) {
  '\0Foo\0foo' => int(1)
  '\0*\0bar' => int(2)
  'baz' => class stdClass#2 (0) {}
}

输出,var_export而不是var_dump

array (
  '' . "\0" . 'Foo' . "\0" . 'foo' => 1,
  '' . "\0" . '*' . "\0" . 'bar' => 2,
  'baz' =>
  stdClass::__set_state(array(
  )),
)

以这种方式进行类型转换不会对对象图进行深层转换,您需要应用空字节(如手册引用中所述)以访问任何非公共属性。因此,这在投射StdClass对象或仅具有公共属性的对象时效果最佳。为了快速又肮脏(您想要的),这很好。

另请参阅此深入的博客文章:


3
还要考虑ArrayAccess接口,也许与该解决方案结合使用。php.net/manual/en/class.arrayaccess.php
alttag

3
如果您有整数键,则会将其转换为字符串,这可能会导致大问题。例如[1 => "one"]成为["1" => "one"]
Oleg

2
自从PHP 4.3 开始,@ Howie 在所有版本中都可以进行类型转换,(array)并且(object)可以可靠地工作。参见3v4l.org/X6lhm。如果遇到语法错误,则说明您做错了什么。
戈登

2
@Howie请参阅的“ 更改日志”部分empty。您不能使用empty5.5之前的表达式。这与类型转换完全无关;)
戈登

4
类型转换。是。输入Freakin CAST!好。+1
Kaushik Makwana '16

344

您可以依靠JSON编码/解码功能的行为,将深层嵌套的对象快速转换为关联数组:

$array = json_decode(json_encode($nested_object), true);

12
如果您想进行完整的深度递归转换(这当然不介意性能不佳),那么这是最好的解决方案
朱利安·哈贝科斯特

2
非常感谢我,这对我的处境完全有所帮助。
Cesar Bielich 2015年

9
恭喜,我认为它仍然可以工作...不要忘记将2nd参数设置为true。
Kirk B

3
第二个参数解决了该问题,适用于PHP 5.6.25。谢谢!
朱奥利维拉

3
非常适合嵌套对象!谢谢!
旋律

68

从第一个Google命中“ PHP对象到assoc数组 ”开始,我们有了:

function object_to_array($data)
{
    if (is_array($data) || is_object($data))
    {
        $result = array();
        foreach ($data as $key => $value)
        {
            $result[$key] = object_to_array($value);
        }
        return $result;
    }
    return $data;
}

来源位于codesnippets.joyent.com


16
就我个人而言,我不喜欢为每个值调用该函数的想法。我有一个类似的版本,但有3行:function objectToArray($o) { $a = array(); foreach ($o as $k => $v) $a[$k] = (is_array($v) || is_object($v)) ? objectToArray($v): $v; return $a; }仅设置不是对象或数组的任何内容,然后继续进行,除非必要,否则无需重复调用该方法。
SpYk3HH 2014年

13
@ SpYk3HH:写下您自己的答案?
DanMan

2
“ php对象到assoc数组的第一个命中”是stackoverflow.com/questions/4345554/…–
克里斯

对于我来说,这个(以及@ SpYk3HH的版本)似乎比json_encode选项(stackoverflow.com/a/16111687/470749)还要慢。我不知道为什么这些方法会更可取。
瑞安

1
@Ryan json编码和解码不适用于float的NaN和INFINITE值,并且可能有其他我无法想到的问题,但在许多情况下,这可能是一个更好的选择。至于优化,它需要的是上下文-让我插入我在这个主题上写的一篇帖子显然是cube.com/blog/game-optimization/when-to-optimize。tl; dr是,不要优化那些不会占用大量运行时间的事情,因为在整个应用程序的上下文中,好处是毫无意义的。
莫里西

61

如果对象属性是公共的,则可以执行以下操作:

$array =  (array) $object;

如果它们是私有的或受保护的,则它们在阵列上将具有奇怪的键名。因此,在这种情况下,您将需要以下功能:

function dismount($object) {
    $reflectionClass = new ReflectionClass(get_class($object));
    $array = array();
    foreach ($reflectionClass->getProperties() as $property) {
        $property->setAccessible(true);
        $array[$property->getName()] = $property->getValue($object);
        $property->setAccessible(false);
    }
    return $array;
}

如果您的财产受到保护,setAccessible(false)会将其变回受保护的可见性吗?还是将其私有化?
尼克·米切尔

我发现的唯一解决方案是使用受保护的属性。谢谢
dav

3
私有和受保护变量的最佳解决方案!!
HIRA THAKUR

这行$ property-> setAccessible(false); 将在所有财产上执行,即使它是公开的...
Francois Bourgeois

太好了...了不起...太棒了 谢谢。
Farid Abbas

14
class Test{
    const A = 1;
    public $b = 'two';
    private $c = test::A;

    public function __toArray(){
        return call_user_func('get_object_vars', $this);
    }
}

$my_test = new Test();
var_dump((array)$my_test);
var_dump($my_test->__toArray());

输出量

array(2) {
    ["b"]=>
    string(3) "two"
    ["Testc"]=>
    int(1)
}
array(1) {
    ["b"]=>
    string(3) "two"
}

1
这个解决方案的利弊?声明为类Test的类怎么样{const A = 1; 公共$ parent = new Test(); }
Matteo Gaggiano's

13

这是一些代码:

function object_to_array($data) {
    if ((! is_array($data)) and (! is_object($data)))
        return 'xxx'; // $data;

    $result = array();

    $data = (array) $data;
    foreach ($data as $key => $value) {
        if (is_object($value))
            $value = (array) $value;
        if (is_array($value))
            $result[$key] = object_to_array($value);
        else
            $result[$key] = $value;
    }
    return $result;
}

最适合我(但我需要删除“ xxx”并返回$ data)
Gerfried

12

此处发布的所有其他答案仅适用于公共属性。这是一种使用反射和吸气剂处理类似JavaBeans的对象的解决方案:

function entity2array($entity, $recursionDepth = 2) {
    $result = array();
    $class = new ReflectionClass(get_class($entity));
    foreach ($class->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
        $methodName = $method->name;
        if (strpos($methodName, "get") === 0 && strlen($methodName) > 3) {
            $propertyName = lcfirst(substr($methodName, 3));
            $value = $method->invoke($entity);

            if (is_object($value)) {
                if ($recursionDepth > 0) {
                    $result[$propertyName] = $this->entity2array($value, $recursionDepth - 1);
                }
                else {
                    $result[$propertyName] = "***";  // Stop recursion
                }
            }
            else {
                $result[$propertyName] = $value;
            }
        }
    }
    return $result;
}

是的,但是……如果您使用对象/数组作为变量,这也是所有这些导致的结果,那么为什么除了public属性之外还需要其他东西?
SpYk3HH 2014年

@ SpYk3HH:我没有问这个问题。我什至不知道为什么没有人首先喜欢数组而不是对象。
弗朗索瓦·布尔乔亚2014年

嗯,我通常更喜欢将查询结果转换为数组,只是为了提供一个统一的“列表”以供循环使用,因为必须“循环”的应用程序中的大多数其他内容都是数组。只是使编写“通用循环方法”变得容易。通常,如果我使用一个对象,则不会遍历其属性,而是将其用作对象,并根据需要使用这些属性。
SpYk3HH 2014年

11

关于什么 get_object_vars($obj)呢 如果只想访问一个对象的公共属性,这似乎很有用。

参见get_object_vars


10

将类型转换为数组。

$arr =  (array) $Obj;

它将解决您的问题。


5
不,如果您具有私有或受保护的属性,则不会。
forsberg

2
最简单的解决方案。谢谢
ASD

6

首先,如果需要对象中的数组,则可能应该首先将数据构造为数组。想一想。

不要使用 foreach语句或JSON转换。如果您打算这样做,那么您将再次使用数据结构,而不是对象。

如果您确实需要它,请使用面向对象的方法来编写干净且可维护的代码。例如:

对象作为数组

class PersonArray implements \ArrayAccess, \IteratorAggregate
{
    public function __construct(Person $person) {
        $this->person = $person;
    }
    // ...
 }

如果需要所有属性,请使用传输对象:

class PersonTransferObject
{
    private $person;

    public function __construct(Person $person) {
        $this->person = $person;
    }

    public function toArray() {
        return [
            // 'name' => $this->person->getName();
        ];
    }

 }

6

您可以轻松地使用此函数来获得结果:

function objetToArray($adminBar){
    $reflector = new ReflectionObject($adminBar);
    $nodes = $reflector->getProperties();
    $out = [];
    foreach ($nodes as $node) {
        $nod = $reflector->getProperty($node->getName());
        $nod->setAccessible(true);
        $out[$node->getName()] = $nod->getValue($adminBar);
    }
    return $out;
}

使用PHP 5或更高版本。


5

这是将PHP对象转换为关联数组的递归PHP函数:

// ---------------------------------------------------------
// ----- object_to_array_recursive --- function (PHP) ------
// ---------------------------------------------------------
// --- arg1: -- $object  =  PHP Object         - required --
// --- arg2: -- $assoc   =  TRUE or FALSE      - optional --
// --- arg3: -- $empty   =  '' (Empty String)  - optional --
// ---------------------------------------------------------
// ----- Return: Array from Object --- (associative) -------
// ---------------------------------------------------------

function object_to_array_recursive($object, $assoc=TRUE, $empty='')
{
    $res_arr = array();

    if (!empty($object)) {

        $arrObj = is_object($object) ? get_object_vars($object) : $object;

        $i=0;
        foreach ($arrObj as $key => $val) {
            $akey = ($assoc !== FALSE) ? $key : $i;
            if (is_array($val) || is_object($val)) {
                $res_arr[$akey] = (empty($val)) ? $empty : object_to_array_recursive($val);
            }
            else {
                $res_arr[$akey] = (empty($val)) ? $empty : (string)$val;
            }
            $i++;
        }
    }
    return $res_arr;
}

// ---------------------------------------------------------
// ---------------------------------------------------------

用法示例:

// ---- Return associative array from object, ... use:
$new_arr1 = object_to_array_recursive($my_object);
// -- or --
// $new_arr1 = object_to_array_recursive($my_object, TRUE);
// -- or --
// $new_arr1 = object_to_array_recursive($my_object, 1);


// ---- Return numeric array from object, ... use:
$new_arr2 = object_to_array_recursive($my_object, FALSE);

3
..或oneliner:$new_arr1 = (array) $my_object;
FooBar 2014年

1
oneliner版本较浅,因此不等效。
乔纳森·利德贝克



4

当您从数据库中获取数据作为对象时,您可能想要这样做:

// Suppose 'result' is the end product from some query $query

$result = $mysqli->query($query);
$result = db_result_to_array($result);

function db_result_to_array($result)
{
    $res_array = array();

    for ($count=0; $row = $result->fetch_assoc(); $count++)
        $res_array[$count] = $row;

    return $res_array;
}

2
有一个接受的答案带有41个投票,而不是1或10、41。您的答案添加了什么?
Yaroslav

4

自定义函数将stdClass转换为数组:

function objectToArray($d) {
    if (is_object($d)) {
        // Gets the properties of the given object
        // with get_object_vars function
        $d = get_object_vars($d);
    }

    if (is_array($d)) {
        /*
        * Return array converted to object
        * Using __FUNCTION__ (Magic constant)
        * for recursive call
        */
        return array_map(__FUNCTION__, $d);
    } else {
        // Return array
        return $d;
    }
}

另一个将Array转换为stdClass的自定义函数:

function arrayToObject($d) {
    if (is_array($d)) {
        /*
        * Return array converted to object
        * Using __FUNCTION__ (Magic constant)
        * for recursive call
        */
        return (object) array_map(__FUNCTION__, $d);
    } else {
        // Return object
        return $d;
    }
}

用法示例:

// Create new stdClass Object
$init = new stdClass;

// Add some test data
$init->foo = "Test data";
$init->bar = new stdClass;
$init->bar->baaz = "Testing";
$init->bar->fooz = new stdClass;
$init->bar->fooz->baz = "Testing again";
$init->foox = "Just test";

// Convert array to object and then object back to array
$array = objectToArray($init);
$object = arrayToObject($array);

// Print objects and array
print_r($init);
echo "\n";
print_r($array);
echo "\n";
print_r($object);

4

采用:

function readObject($object) {
    $name = get_class ($object);
    $name = str_replace('\\', "\\\\", $name); \\ Outcomment this line, if you don't use
                                              \\ class namespaces approach in your project
    $raw = (array)$object;

    $attributes = array();
    foreach ($raw as $attr => $val) {
        $attributes[preg_replace('('.$name.'|\*|)', '', $attr)] = $val;
    }
    return $attributes;
}

它返回一个没有特殊字符和类名的数组。


4

这个答案只是本文不同答案的结合,但这是将具有简单值或数组的公共或私有属性的PHP对象转换为关联数组的解决方案...

function object_to_array($obj)
{
    if (is_object($obj))
        $obj = (array)$this->dismount($obj);
    if (is_array($obj)) {
        $new = array();
        foreach ($obj as $key => $val) {
            $new[$key] = $this->object_to_array($val);
        }
    }
    else
        $new = $obj;
    return $new;
}

function dismount($object)
{
    $reflectionClass = new \ReflectionClass(get_class($object));
    $array = array();
    foreach ($reflectionClass->getProperties() as $property) {
        $property->setAccessible(true);
        $array[$property->getName()] = $property->getValue($object);
        $property->setAccessible(false);
    }
    return $array;
}

3

对“知识渊博”代码的一些改进

/*** mixed Obj2Array(mixed Obj)***************************************/ 
static public function Obj2Array($_Obj) {
    if (is_object($_Obj))
        $_Obj = get_object_vars($_Obj);
    return(is_array($_Obj) ? array_map(__METHOD__, $_Obj) : $_Obj);   
} // BW_Conv::Obj2Array

请注意,如果函数是类的成员(如上),则必须更改__FUNCTION____METHOD__


3

您也可以使用Symfony序列化器组件

use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;

$serializer = new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
$array = json_decode($serializer->serialize($object, 'json'), true);

3

对于您的情况,如果您使用“装饰器”或“日期模型转换”模式,那是正确/美丽的。例如:

您的模特

class Car {
    /** @var int */
    private $color;

    /** @var string */
    private $model;

    /** @var string */
    private $type;

    /**
     * @return int
     */
    public function getColor(): int
    {
        return $this->color;
    }

    /**
     * @param int $color
     * @return Car
     */
    public function setColor(int $color): Car
    {
        $this->color = $color;
        return $this;
    }

    /**
     * @return string
     */
    public function getModel(): string
    {
        return $this->model;
    }

    /**
     * @param string $model
     * @return Car
     */
    public function setModel(string $model): Car
    {
        $this->model = $model;

        return $this;
    }

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @param string $type
     * @return Car
     */
    public function setType(string $type): Car
    {
        $this->type = $type;

        return $this;
    }
}

装饰器

class CarArrayDecorator
{
    /** @var Car */
    private $car;

    /**
     * CarArrayDecorator constructor.
     * @param Car $car
     */
    public function __construct(Car $car)
    {
        $this->car = $car;
    }

    /**
     * @return array
     */
    public function getArray(): array
    {
        return [
            'color' => $this->car->getColor(),
            'type' => $this->car->getType(),
            'model' => $this->car->getModel(),
        ];
    }
}

用法

$car = new Car();
$car->setType('type#');
$car->setModel('model#1');
$car->setColor(255);

$carDecorator = new CarArrayDecorator($car);
$carResponseData = $carDecorator->getArray();

因此,它将是更美丽,更正确的代码。


3

转换和删除烦人的星星:

$array = (array) $object;
foreach($array as $key => $val)
{
    $new_array[str_replace('*_', '', $key)] = $val;
}

可能会比使用反射便宜。


2

@ SpYk3HH的简短解决方案

function objectToArray($o)
{
    $a = array();
    foreach ($o as $k => $v)
        $a[$k] = (is_array($v) || is_object($v)) ? objectToArray($v): $v;

    return $a;
}

2

由于很多人是因为无法动态访问对象的属性而发现此问题,因此我只想指出您可以在PHP中执行此操作: $valueRow->{"valueName"}

在上下文中(已删除HTML输出以提高可读性):

$valueRows = json_decode("{...}"); // Rows of unordered values decoded from a JSON object

foreach ($valueRows as $valueRow) {

    foreach ($references as $reference) {

        if (isset($valueRow->{$reference->valueName})) {
            $tableHtml .= $valueRow->{$reference->valueName};
        }
        else {
            $tableHtml .= " ";
        }
    }
}

2

通过使用类型转换,可以解决您的问题。只需将以下几行添加到您的返回对象中:

$arrObj = array(yourReturnedObject);

您还可以使用以下方法向其添加新的键和值对:

$arrObj['key'] = value;

2

我认为使用特征存储对象到数组的转换逻辑是一个好主意。一个简单的例子:

trait ArrayAwareTrait
{
    /**
     * Return list of Entity's parameters
     * @return array
     */
    public function toArray()
    {
        $props = array_flip($this->getPropertiesList());
        return array_map(
            function ($item) {
                if ($item instanceof \DateTime) {
                    return $item->format(DATE_ATOM);
                }
                return $item;
            },
            array_filter(get_object_vars($this), function ($key) use ($props) {
                return array_key_exists($key, $props);
            }, ARRAY_FILTER_USE_KEY)
        );
    }


    /**
     * @return array
     */
    protected function getPropertiesList()
    {
        if (method_exists($this, '__sleep')) {
            return $this->__sleep();
        }
        if (defined('static::PROPERTIES')) {
            return static::PROPERTIES;
        }
        return [];
    }
}

class OrderResponse
{
    use ArrayAwareTrait;

    const PROP_ORDER_ID = 'orderId';
    const PROP_TITLE = 'title';
    const PROP_QUANTITY = 'quantity';
    const PROP_BUYER_USERNAME = 'buyerUsername';
    const PROP_COST_VALUE = 'costValue';
    const PROP_ADDRESS = 'address';

    private $orderId;
    private $title;
    private $quantity;
    private $buyerUsername;
    private $costValue;
    private $address;

    /**
     * @param $orderId
     * @param $title
     * @param $quantity
     * @param $buyerUsername
     * @param $costValue
     * @param $address
     */
    public function __construct(
        $orderId,
        $title,
        $quantity,
        $buyerUsername,
        $costValue,
        $address
    ) {
        $this->orderId = $orderId;
        $this->title = $title;
        $this->quantity = $quantity;
        $this->buyerUsername = $buyerUsername;
        $this->costValue = $costValue;
        $this->address = $address;
    }

    /**
     * @inheritDoc
     */
    public function __sleep()
    {
        return [
            static::PROP_ORDER_ID,
            static::PROP_TITLE,
            static::PROP_QUANTITY,
            static::PROP_BUYER_USERNAME,
            static::PROP_COST_VALUE,
            static::PROP_ADDRESS,
        ];
    }

    /**
     * @return mixed
     */
    public function getOrderId()
    {
        return $this->orderId;
    }

    /**
     * @return mixed
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @return mixed
     */
    public function getQuantity()
    {
        return $this->quantity;
    }

    /**
     * @return mixed
     */
    public function getBuyerUsername()
    {
        return $this->buyerUsername;
    }

    /**
     * @return mixed
     */
    public function getCostValue()
    {
        return $this->costValue;
    }

    /**
     * @return string
     */
    public function getAddress()
    {
        return $this->address;
    }
}

$orderResponse = new OrderResponse(...);
var_dump($orderResponse->toArray());


1

在这里,我制作了一个objectToArray()方法,该方法也适用于递归对象,例如何时$objectAcontains $objectB再次指向$objectA

另外,我使用ReflectionClass将输出限制为公共属性。如果不需要它,请摆脱它。

    /**
     * Converts given object to array, recursively.
     * Just outputs public properties.
     *
     * @param object|array $object
     * @return array|string
     */
    protected function objectToArray($object) {
        if (in_array($object, $this->usedObjects, TRUE)) {
            return '**recursive**';
        }
        if (is_array($object) || is_object($object)) {
            if (is_object($object)) {
                $this->usedObjects[] = $object;
            }
            $result = array();
            $reflectorClass = new \ReflectionClass(get_class($this));
            foreach ($object as $key => $value) {
                if ($reflectorClass->hasProperty($key) && $reflectorClass->getProperty($key)->isPublic()) {
                    $result[$key] = $this->objectToArray($value);
                }
            }
            return $result;
        }
        return $object;
    }

为了标识已经使用过的对象,我正在这个(抽象)类中使用一个受保护的属性,名为$this->usedObjects。如果找到了一个递归嵌套对象,它将被字符串替换**recursive**。否则它将因无限循环而失败。


$usedObjects不会在一开始就初始化,因此多次调用将在以后的调用中产生错误的结果。另外,您不会在最后释放它,因此您的对象将永远不会从内存中删除。
HappyDog

1

如果您的对象中甚至有私有成员,都有我的建议:

public function dismount($object) {
    $reflectionClass = new \ReflectionClass(get_class($object));
    $array = array();
    foreach ($reflectionClass->getProperties() as $property) {
        $property->setAccessible(true);
        if (is_object($property->getValue($object))) {
            $array[$property->getName()] = $this->dismount($property->getValue($object));
        } else {
            $array[$property->getName()] = $property->getValue($object);
        }
        $property->setAccessible(false);
    }
    return $array;
}

1

我使用这个(需要具有正确密钥的递归解决方案):

    /**
     * This method returns the array corresponding to an object, including non public members.
     *
     * If the deep flag is true, is will operate recursively, otherwise (if false) just at the first level.
     *
     * @param object $obj
     * @param bool $deep = true
     * @return array
     * @throws \Exception
     */
    public static function objectToArray(object $obj, bool $deep = true)
    {
        $reflectionClass = new \ReflectionClass(get_class($obj));
        $array = [];
        foreach ($reflectionClass->getProperties() as $property) {
            $property->setAccessible(true);
            $val = $property->getValue($obj);
            if (true === $deep && is_object($val)) {
                $val = self::objectToArray($val);
            }
            $array[$property->getName()] = $val;
            $property->setAccessible(false);
        }
        return $array;
    }

使用示例,以下代码:

class AA{
    public $bb = null;
    protected $one = 11;

}

class BB{
    protected $two = 22;
}


$a = new AA();
$b = new BB();
$a->bb = $b;

var_dump($a)

将打印此:

array(2) {
  ["bb"] => array(1) {
    ["two"] => int(22)
  }
  ["one"] => int(11)
}

我们如何升级您的功能以支持具有对象数组的对象?
celsowm
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.