Skip to content

14123 Document denormalize groups value '*' #15909

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
Jul 22, 2022
Merged

14123 Document denormalize groups value '*' #15909

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
27 changes: 26 additions & 1 deletion components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,11 @@ Then, create your groups definition:
*/
public $foo;

/**
* @Groups({"group4"})
*/
public $anotherProperty;

/**
* @Groups("group3")
*/
Expand All @@ -328,6 +333,9 @@ Then, create your groups definition:
#[Groups(['group1', 'group2'])]
public $foo;

#[Groups(['group4'])]
public $anotherProperty;

#[Groups(['group3'])]
public function getBar() // is* methods are also supported
{
Expand All @@ -343,6 +351,8 @@ Then, create your groups definition:
attributes:
foo:
groups: ['group1', 'group2']
anotherProperty:
groups: ['group4']
bar:
groups: ['group3']

Expand All @@ -360,6 +370,10 @@ Then, create your groups definition:
<group>group2</group>
</attribute>

<attribute name="anotherProperty">
<group>group4</group>
</attribute>

<attribute name="bar">
<group>group3</group>
</attribute>
Expand All @@ -373,6 +387,7 @@ You are now able to serialize only attributes in the groups you want::

$obj = new MyObj();
$obj->foo = 'foo';
$obj->anotherProperty = 'anotherProperty';
$obj->setBar('bar');

$normalizer = new ObjectNormalizer($classMetadataFactory);
Expand All @@ -382,13 +397,23 @@ You are now able to serialize only attributes in the groups you want::
// $data = ['foo' => 'foo'];

$obj2 = $serializer->denormalize(
['foo' => 'foo', 'bar' => 'bar'],
['foo' => 'foo', 'anotherProperty' => 'anotherProperty', 'bar' => 'bar'],
'MyObj',
null,
['groups' => ['group1', 'group3']]
);
// $obj2 = MyObj(foo: 'foo', bar: 'bar')

// You can use `groups` with value `*` to get all groups:

$obj3 = $serializer->denormalize(
['foo' => 'foo', 'anotherProperty' => 'anotherProperty', 'bar' => 'bar'],
'MyObj',
null,
['groups' => ['*']]
);
// $obj2 = MyObj(foo: 'foo', anotherProperty: 'anotherProperty', bar: 'bar')

.. _ignoring-attributes-when-serializing:

Selecting Specific Attributes
Expand Down