Skip to content

Codeigniter\Entity - Added $deep parameter in toArray and toRawArray #3495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2020
Merged

Codeigniter\Entity - Added $deep parameter in toArray and toRawArray #3495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 57 additions & 4 deletions system/Entity.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,12 @@ public function fill(array $data = null)
*
* @param boolean $onlyChanged If true, only return values that have changed since object creation
* @param boolean $cast If true, properties will be casted.
* @param boolean $recursive If true, inner entities will be casted as array as well.
*
* @return array
* @throws \Exception
*/
public function toArray(bool $onlyChanged = false, bool $cast = true): array
public function toArray(bool $onlyChanged = false, bool $cast = true, bool $recursive = false): array
{
$this->_cast = $cast;
$return = [];
Expand All @@ -164,6 +165,18 @@ public function toArray(bool $onlyChanged = false, bool $cast = true): array
}

$return[$key] = $this->__get($key);

if ($recursive)
{
if ($return[$key] instanceof Entity)
{
$return[$key] = $return[$key]->toArray($onlyChanged, $cast, $recursive);
}
elseif (is_callable([$return[$key], 'toArray']))
{
$return[$key] = $return[$key]->toArray();
}
}
}

// Loop over our mapped properties and add them to the list...
Expand All @@ -174,6 +187,18 @@ public function toArray(bool $onlyChanged = false, bool $cast = true): array
if (array_key_exists($to, $return))
{
$return[$from] = $this->__get($to);

if ($recursive)
{
if ($return[$from] instanceof Entity)
{
$return[$from] = $return[$from]->toArray($onlyChanged, $cast, $recursive);
}
elseif (is_callable([$return[$from], 'toArray']))
{
$return[$from] = $return[$from]->toArray();
}
}
}
}
}
Expand All @@ -187,16 +212,32 @@ public function toArray(bool $onlyChanged = false, bool $cast = true): array
/**
* Returns the raw values of the current attributes.
*
* @param boolean $onlyChanged
* @param boolean $onlyChanged If true, only return values that have changed since object creation
* @param boolean $recursive If true, inner entities will be casted as array as well.
*
* @return array
*/
public function toRawArray(bool $onlyChanged = false): array
public function toRawArray(bool $onlyChanged = false, bool $recursive = false): array
{
$return = [];

if (! $onlyChanged)
{
if ($recursive)
{
return array_map(function ($value) use ($onlyChanged, $recursive) {
if ($value instanceof Entity)
{
$value = $value->toRawArray($onlyChanged, $recursive);
}
elseif (is_callable([$value, 'toRawArray']))
{
$value = $value->toRawArray();
}
return $value;
}, $this->attributes);
}

return $this->attributes;
}

Expand All @@ -207,7 +248,19 @@ public function toRawArray(bool $onlyChanged = false): array
continue;
}

$return[$key] = $this->attributes[$key];
if ($recursive)
{
if ($value instanceof Entity)
{
$value = $value->toRawArray($onlyChanged, $recursive);
}
elseif (is_callable([$value, 'toRawArray']))
{
$value = $value->toRawArray();
}
}

$return[$key] = $value;
}

return $return;
Expand Down
55 changes: 50 additions & 5 deletions tests/system/EntityTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,29 @@ public function testAsArray()
]);
}

public function testAsArrayRecursive()
{
$entity = $this->getEntity();
$entity->entity = $this->getEntity();

$result = $entity->toArray(false, true, true);

$this->assertEquals($result, [
'foo' => null,
'bar' => ':bar',
'default' => 'sumfin',
'created_at' => null,
'createdAt' => null,
'entity' => [
'foo' => null,
'bar' => ':bar',
'default' => 'sumfin',
'created_at' => null,
'createdAt' => null,
],
]);
}

public function testAsArrayMapped()
{
$entity = $this->getMappedEntity();
Expand Down Expand Up @@ -694,6 +717,27 @@ public function testToRawArray()
]);
}

public function testToRawArrayRecursive()
{
$entity = $this->getEntity();
$entity->entity = $this->getEntity();

$result = $entity->toRawArray(false, true);

$this->assertEquals($result, [
'foo' => null,
'bar' => null,
'default' => 'sumfin',
'created_at' => null,
'entity' => [
'foo' => null,
'bar' => null,
'default' => 'sumfin',
'created_at' => null,
],
]);
}

public function testToRawArrayOnlyChanged()
{
$entity = $this->getEntity();
Expand Down Expand Up @@ -799,7 +843,7 @@ public function testJsonSerializableEntity()
$this->assertEquals(json_encode($entity->toArray()), json_encode($entity));
}

protected function getEntity()
protected function getEntity() : Entity
{
return new class extends Entity
{
Expand Down Expand Up @@ -840,7 +884,7 @@ public function getFakeBar()
};
}

protected function getMappedEntity()
protected function getMappedEntity() : Entity
{
return new class extends Entity
{
Expand Down Expand Up @@ -872,7 +916,7 @@ protected function getSimple()
};
}

protected function getCastEntity($data = null)
protected function getCastEntity($data = null) : Entity
{
return new class($data) extends Entity
{
Expand Down Expand Up @@ -926,7 +970,7 @@ public function setSeventh($seventh)
};
}

protected function getCastNullableEntity()
protected function getCastNullableEntity() : Entity
{
return new class extends Entity
{
Expand All @@ -937,7 +981,8 @@ protected function getCastNullableEntity()
'integer_0' => null,
'string_value_not_null' => 'value',
];
protected $_original = [

protected $_original = [
'string_null' => null,
'string_empty' => null,
'integer_null' => null,
Expand Down
2 changes: 1 addition & 1 deletion tests/system/View/ParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ public function testParseLoopEntityProperties()
$power = new class extends \CodeIgniter\Entity {
public $foo = 'bar';
protected $bar = 'baz';
public function toArray(bool $onlyChanged = false, bool $cast = true): array
public function toArray(bool $onlyChanged = false, bool $cast = true, bool $recursive = false): array
{
return [
'foo' => $this->foo,
Expand Down