NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.8k

[Serializer] Add the possibility to filter attributes#18834

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

fabpot merged 1 commit intosymfony:masterfromdunglas:serializer_attributes

Feb 13, 2017

Merged

[Serializer] Add the possibility to filter attributes#18834

fabpot merged 1 commit intosymfony:masterfromdunglas:serializer_attributes

Feb 13, 2017

Conversation

Copy link

Member

dunglas commentedMay 22, 2016•
edited
Loading

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	todo

This new features give the possibility to the end user to select select fields to normalize.

Exemple:

class Foo{public$a ='1';public$b ='2';public$c ='3';}$normalizer =new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer();$normalizer->normalize(newFoo(),null, ['attributes' => ['a','c']]);// ['a' => '1', 'c' => '3']

Denormalization is also supported. This feature works for any normalizer using theSymfony\Component\Serializer\Normalizer\AbstractNormalizer class.

The main use case is to permit to API clients to optimize responses length by dropping unnecessary information like in the following example:

http://exemple.com/cars?fields=a,c{'a' => 1, 'c' => 2}

Nested parameters are also supported:

class Foo{public$a ='1';public$b ='2';public$c ='3';public$bar =newBar();}class Bar{public$x ='x';public$y ='y';public$z ='z';}$serializer =new \Symfony\Component\Serializer(    [new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer()]);$serializer->normalize(newFoo(),null, ['attributes' => ['a','c','bar' => ['y']]]);// ['a' => '1', 'c' => '3', 'bar' => ['y' => 'y']

Thanks to this PR, support for this feature will be available out of the box inAPI Platform.

dunglas added Serializer Feature labels

May 22, 2016

carsonbot added the Status: Needs Review label

May 22, 2016

Copy link

Contributor

GuilhemN commentedMay 22, 2016•
edited
Loading

Your example in the description is wrong, the context should be a nested array['attributes' => ['a', 'c']].
Otherwise, this looks great!

Copy link

Contributor

Simperfit commentedMay 22, 2016

👍

Copy link

MemberAuthor

dunglas commentedMay 22, 2016

Good catch @Ener-Getick, thanks!

Copy link

Contributor

theofidry commentedMay 22, 2016•
edited
Loading

Is there a support for nested attributes as well? Example:

class Foo {public$bar;publicfunction__construct(Bar$bar) {$this->bar =$bar;  }}class Bar {public$a =1;public$b =2;}$normalizer =new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer();$normalizer->normalize(newFoo(newBar()),null, ['attributes' => ['bar.a']]);// => ['bar.a' => 1]

javiereguiluz added BC Break Deprecation labels

May 23, 2016

Copy link

Contributor

GuilhemN commentedJun 7, 2016•
edited
Loading

@theofidry no this isn't possible.

@dunglas maybe an associative array could be used to allow nested attributes safely ?

['attributes' => ['a' => ['b' => [],'c' => ['d' ]        ],'e' => []    ]]

BTW there are no bc breaks/deprecations in this PR, so this can be removed from the pr header.

dunglas removed BC Break Deprecation labels

Jun 7, 2016

Copy link

Member

fabpot commentedJun 16, 2016

Sounds like a good new feature.@dunglas Can you finish it?

Copy link

Member

dunglas commentedSep 14, 2016

Yes I've an idea of how to manage related entities. I'll finish this one ASAP.

nicolas-grekas added this to the3.x milestone

Dec 6, 2016

dunglas mentioned this pull request

Dec 19, 2016

[question] How to implement ?fields=name,email filter?api-platform/api-platform#193

Closed

Copy link

Contributor

teohhanhui commentedDec 20, 2016

I think it's crucial to have nested attributes support, and in a nice syntax. Perhaps using PropertyAccess path...

The semantics could be something like this: If one attribute is specified for a certain object / item, then all attributes on the same object / item need to be specified (otherwise they will be omitted). Similar to how Prophecy mocks work.

Copy link

Member

xabbuh commentedDec 28, 2016

Making use of the PropertyAccess component for this feature sounds like a good idea to me.

dunglas force-pushed theserializer_attributes branch fromf7b9ca8 to527bc77Compare

February 3, 2017 18:21

Copy link

MemberAuthor

dunglas commentedFeb 3, 2017•
edited
Loading

I eventually added support for nested attributes (it works for normalization and denormalization).

Usage:

class Foo{public$a ='1';public$b ='2';public$c ='3';public$bar =newBar();}class Bar{public$x ='x';public$y ='y';public$z ='z';}$serializer =new \Symfony\Component\Serializer(    [new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer()]);$serializer->normalize(newFoo(),null, ['attributes' => ['a','c','bar' => ['y']]]);// ['a' => '1', 'c' => '3', 'bar' => ['y' => 'y']

This PR is ready now. ping @symfony/deciders

dunglas modified the milestones:3.3,3.x

Feb 4, 2017

[Serializer] Add the possibility to filter attributes

b3826fb

dunglas force-pushed theserializer_attributes branch fromcebc036 tob3826fbCompare

February 13, 2017 10:26

nicolas-grekas changed the title~~[Serializer] Add the possibilitiy to filter attributes~~[Serializer] Add the possibility to filter attributes

Feb 13, 2017

nicolas-grekas approved these changes

Feb 13, 2017

View reviewed changes

Copy link

Member

nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

👍

nicolas-grekas added the Ready label

Feb 13, 2017

Copy link

Member

fabpot commentedFeb 13, 2017

@dunglas Can you submit a PR on the docs?

Copy link

Member

fabpot commentedFeb 13, 2017

Thank you@dunglas.

fabpot merged commitb3826fb intosymfony:master

Feb 13, 2017

fabpot added a commit that referenced this pull request

Feb 13, 2017

feature#18834[Serializer] Add the possibility to filter attributes …

e43bd57

…(dunglas)This PR was merged into the 3.3-dev branch.Discussion----------[Serializer] Add the possibility to filter attributes| Q | A || --- | --- || Branch? | master || Bug fix? | no || New feature? | yes || BC breaks? | no || Deprecations? | no || Tests pass? | yes || Fixed tickets | n/a || License | MIT || Doc PR | todo |This new features give the possibility to the end user to select select fields to normalize.Exemple:``` phpclass Foo{    public $a = '1';    public $b = '2';    public $c = '3';}$normalizer = new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer();$normalizer->normalize(new Foo(), null, ['attributes' => ['a', 'c']]);// ['a' => '1', 'c' => '3']```Denormalization is also supported. This feature works for any normalizer using the `Symfony\Component\Serializer\Normalizer\AbstractNormalizer` class.The main use case is to permit to API clients to optimize responses length by dropping unnecessary information like in the following example:```http://exemple.com/cars?fields=a,c{'a' => 1, 'c' => 2}```Thanks to this PR, support for this feature will be available out of the box in [API Platform](https://api-platform.com).Commits-------b3826fb [Serializer] Add the possibility to filter attributes

dunglas deleted the serializer_attributes branch

February 13, 2017 14:34

javiereguiluz mentioned this pull request

Feb 26, 2017

[Serializer] Add the possibility to filter attributessymfony/symfony-docs#7542

Closed

This was referencedApr 15, 2017

[Feature Request] Resource Expansionapi-platform/core#1062

Closed

Question (normalization) : dynamically embed relations?api-platform/api-platform#284

Closed

dunglas mentioned this pull request

Apr 26, 2017

Add a filter to select specific fieldsapi-platform/core#1083

Closed

fabpot mentioned this pull request

May 1, 2017

Release v3.3.0-BETA1#22603

Merged

dunglas mentioned this pull request

Sep 11, 2017

GraphQL Query supportapi-platform/core#1358

Merged

This was referencedDec 4, 2017

[Serializer] Add docs for attributes context keysymfony/symfony-docs#8830

Merged

[Serializer] Unset attributes when creating child context#25340

Merged

fabpot added a commit that referenced this pull request

Dec 7, 2017

bug#25340[Serializer] Unset attributes when creating child context …

d7cb006

…(dunglas)This PR was merged into the 3.3 branch.Discussion----------[Serializer] Unset attributes when creating child context | Q             | A | ------------- | --- | Branch?       | 3.3 | Bug fix?      | yes | New feature?  | no | BC breaks?    | no | Deprecations? | no | Tests pass?   | yes | Fixed tickets | n/a | License       | MIT | Doc PR        | n/aIn some cases, the `attributes` key isn't overrode when creating the context passed to nested normalizers. It's definitely a bug, but an attacker cannot access to non public data (ignored attributes are checked before the `attributes` key). However some data that must be public may be missing as highlighted by the test.I've introduced the initial bug here:#18834Commits-------4ff9d99 [Serializer] Unset attributes when creating child context

weaverryan added a commit to symfony/symfony-docs that referenced this pull request

Dec 13, 2017

feature#8830[Serializer] Add docs for attributes context key (dungl…

999d56f

…as, javiereguiluz)This PR was merged into the 3.3 branch.Discussion----------[Serializer] Add docs for attributes context keyDocumentation forsymfony/symfony#18834Commits-------d48d6d4 Minor rewordea211ab Review5d75696 [Serializer] Add docs for attributes context key