[Serializer] Add the possibility to filter attributes #18834

dunglas · 2016-05-22T08:06:03Z

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(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}

Nested parameters are also supported:

class Foo
{
    public $a = '1';
    public $b = '2';
    public $c = '3';
    public $bar = new Bar();
}

class Bar
{
    public $x = 'x';
    public $y = 'y';
    public $z = 'z';
}

$serializer = new \Symfony\Component\Serializer(
    [new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer()]
);
$serializer->normalize(new Foo(), 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 in API Platform.

GuilhemN · 2016-05-22T08:31:27Z

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

Simperfit · 2016-05-22T08:31:57Z

👍

dunglas · 2016-05-22T09:21:51Z

Good catch @Ener-Getick, thanks!

theofidry · 2016-05-22T10:10:20Z

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

class Foo {
  public $bar;

  public function __construct(Bar $bar) {
    $this->bar = $bar;
  }
}

class Bar {
  public $a = 1;
  public $b = 2;
}

$normalizer = new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer();
$normalizer->normalize(new Foo(new Bar()), null, ['attributes' => ['bar.a']]);
// => ['bar.a' => 1]

GuilhemN · 2016-06-07T11:40:25Z

@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.

fabpot · 2016-06-16T20:11:56Z

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

fabpot · 2016-09-14T22:25:18Z

Any news?

dunglas · 2016-09-14T23:22:43Z

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

teohhanhui · 2016-12-20T03:52:35Z

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.

xabbuh · 2016-12-28T23:24:14Z

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

dunglas · 2017-02-03T19:38:46Z

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 = new Bar();
}

class Bar
{
    public $x = 'x';
    public $y = 'y';
    public $z = 'z';
}

$serializer = new \Symfony\Component\Serializer(
    [new \Symfony\Component\Serializer\Normalizer\ObjectNormalizer()]
);
$serializer->normalize(new Foo(), null, ['attributes' => ['a', 'c', 'bar' => ['y']]]);
// ['a' => '1', 'c' => '3', 'bar' => ['y' => 'y']

This PR is ready now. ping @symfony/deciders

nicolas-grekas

👍

fabpot · 2017-02-13T14:11:16Z

@dunglas Can you submit a PR on the docs?

fabpot · 2017-02-13T14:12:21Z

Thank you @dunglas.

…(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: ``` php class 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) 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/a In 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: #18834 Commits ------- 4ff9d99 [Serializer] Unset attributes when creating child context

…as, javiereguiluz) This PR was merged into the 3.3 branch. Discussion ---------- [Serializer] Add docs for attributes context key Documentation for symfony/symfony#18834 Commits ------- d48d6d4 Minor reword ea211ab Review 5d75696 [Serializer] Add docs for attributes context key

dunglas added Serializer Feature labels May 22, 2016

carsonbot added the Status: Needs Review label May 22, 2016

javiereguiluz added BC Break Deprecation labels May 23, 2016

dunglas removed BC Break Deprecation labels Jun 7, 2016

nicolas-grekas added this to the 3.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

dunglas force-pushed the serializer_attributes branch from f7b9ca8 to 527bc77 Compare February 3, 2017 18:21

dunglas modified the milestones: 3.3, 3.x Feb 4, 2017

[Serializer] Add the possibility to filter attributes

b3826fb

dunglas force-pushed the serializer_attributes branch from cebc036 to b3826fb Compare 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

nicolas-grekas added the Ready label Feb 13, 2017

fabpot merged commit b3826fb into symfony:master Feb 13, 2017

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 attributes symfony/symfony-docs#7542

Closed

This was referenced Apr 15, 2017

[Feature Request] Resource Expansion api-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 fields api-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 support api-platform/core#1358

Merged

This was referenced Dec 4, 2017

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

Merged

[Serializer] Unset attributes when creating child context #25340

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Add the possibility to filter attributes #18834

[Serializer] Add the possibility to filter attributes #18834

dunglas commented May 22, 2016 •

edited

Loading

GuilhemN commented May 22, 2016 •

edited

Loading

Simperfit commented May 22, 2016

dunglas commented May 22, 2016

theofidry commented May 22, 2016 •

edited

Loading

GuilhemN commented Jun 7, 2016 •

edited

Loading

fabpot commented Jun 16, 2016

fabpot commented Sep 14, 2016

dunglas commented Sep 14, 2016

teohhanhui commented Dec 20, 2016

xabbuh commented Dec 28, 2016

dunglas commented Feb 3, 2017 •

edited

Loading

nicolas-grekas left a comment

fabpot commented Feb 13, 2017

fabpot commented Feb 13, 2017

[Serializer] Add the possibility to filter attributes #18834

[Serializer] Add the possibility to filter attributes #18834

Conversation

dunglas commented May 22, 2016 • edited Loading

GuilhemN commented May 22, 2016 • edited Loading

Simperfit commented May 22, 2016

dunglas commented May 22, 2016

theofidry commented May 22, 2016 • edited Loading

GuilhemN commented Jun 7, 2016 • edited Loading

fabpot commented Jun 16, 2016

fabpot commented Sep 14, 2016

dunglas commented Sep 14, 2016

teohhanhui commented Dec 20, 2016

xabbuh commented Dec 28, 2016

dunglas commented Feb 3, 2017 • edited Loading

nicolas-grekas left a comment

Choose a reason for hiding this comment

fabpot commented Feb 13, 2017

fabpot commented Feb 13, 2017

dunglas commented May 22, 2016 •

edited

Loading

GuilhemN commented May 22, 2016 •

edited

Loading

theofidry commented May 22, 2016 •

edited

Loading

GuilhemN commented Jun 7, 2016 •

edited

Loading

dunglas commented Feb 3, 2017 •

edited

Loading