Skip to content

[Serializer] Return an ArrayObject for empty collection objects when PRESERVE_EMPTY_OBJECTS is set #42730

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 25, 2021
Merged

[Serializer] Return an ArrayObject for empty collection objects when PRESERVE_EMPTY_OBJECTS is set #42730

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
2 changes: 1 addition & 1 deletion src/Symfony/Component/Serializer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CHANGELOG

* Add support of PHP backed enumerations
* Add support for serializing empty array as object
* Deprecate support for returning empty, iterable, countable, raw object when normalizing
* Return empty collections as `ArrayObject` from `Serializer::normalize()` when `PRESERVE_EMPTY_OBJECTS` is set

5.3
---
Expand Down
17 changes: 6 additions & 11 deletions src/Symfony/Component/Serializer/Serializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,18 +164,13 @@ public function normalize($data, string $format = null, array $context = [])
return $data;
}

if (\is_array($data) && !$data && ($context[self::EMPTY_ARRAY_AS_OBJECT] ?? false)) {
return new \ArrayObject();
}

if (is_iterable($data)) {
if (is_countable($data) && 0 === \count($data)) {
switch (true) {
case ($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && \is_object($data):
if (!$data instanceof \ArrayObject) {
trigger_deprecation('symfony/serializer', '5.4', 'Returning empty object of class "%s" from "%s()" is deprecated. This class should extend "ArrayObject".', get_debug_type($data), __METHOD__);
}

return $data;
case ($context[self::EMPTY_ARRAY_AS_OBJECT] ?? false) && \is_array($data):
return new \ArrayObject();
}
if ($data instanceof \Countable && ($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && !\count($data)) {
return new \ArrayObject();
}

$normalized = [];
Expand Down
59 changes: 2 additions & 57 deletions src/Symfony/Component/Serializer/Tests/SerializerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ public function testNormalizeWithCollection(Serializer $serializer, array $data)
/** @dataProvider provideObjectOrCollectionTests */
public function testNormalizePreserveEmptyArrayObject(Serializer $serializer, array $data)
{
$expected = '{"a1":{},"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{"list":[]},"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$expected = '{"a1":{},"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{},"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
Expand All @@ -599,62 +599,7 @@ public function testNormalizeEmptyArrayAsObject(Serializer $serializer, array $d
/** @dataProvider provideObjectOrCollectionTests */
public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObject(Serializer $serializer, array $data)
{
$expected = '{"a1":{},"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{"list":[]},"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizeWithCollectionLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":[],"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":[]},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":[]},"f2":{"map":{"k":"v"}},"g1":{"list":[],"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json'));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizePreserveEmptyArrayObjectLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":{},"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{"list":[]},"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizeEmptyArrayAsObjectLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":[],"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":[]},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":[]},"f2":{"map":{"k":"v"}},"g1":{"list":[],"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
]));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObjectLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":{},"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{"list":[]},"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$expected = '{"a1":{},"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{},"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
Expand Down