[Serializer] Add a MaxDepth option #17113

dunglas · 2015-12-22T18:54:52Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#14924 (comment), api-platform/core#104 (comment)
License	MIT
Doc PR	todo

Add a max depth option during the normalization process. Especially useful when normalizing trees.

Usage:

use Symfony\Component\Serializer\Annotation\MaxDepth;

class MyObj
{
    /**
     * @MaxDepth(2)
     */
    public $foo;

    /**
     * @var self
     */
    public $child;
}

use Doctrine\Common\Annotations\AnnotationReader;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;

$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$normalizer = new ObjectNormalizer($classMetadataFactory);
$serializer = new Serializer(array($this->normalizer));

$level1 = new MyObj();
$level1->foo = 'level1';

$level2 = new MyObj();
$level2->foo = 'level2';
$level1->child = $level2;

$level3 = new MyObj();
$level3->foo = 'level3';
$level2->child = $level3;
$result = $serializer->normalize($level1, null, array(ObjectNormalizer::ENABLE_MAX_DEPTH => true));
/*      $result = array(
            'foo' => 'level1',
            'child' => array(
                    'foo' => 'level2',
                    'child' => array(
                            'child' => null,
                        ),
                ),
        );
*/

Metadata support
@MaxDepth(2) annotation and loader
XML loader
YAML loader
Delegate recursive normalization at the end of the process
Use constants with Late Static Binding in the abstract class instead of raw strings
Move common logic to the abstract class

/cc @mRoca @csarrazi

GuilhemN · 2015-12-22T19:53:26Z

src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php

+     *
+     * @param int|null $maxDepth
+     */
+    public function setMaxDepth($maxDepth);


Isn't that a BC break?

Good catch, needs a new interface...

By the way, I think than introducing such interfaces was a (my) mistake. Serializer Metadata are value objects. Nobody will (nor should) implement these interfaces. Composition is better for "extending" metadata.

What do you think about marking them as @internal (and even deprecated) @symfony/deciders?

#17114 merged

GuilhemN · 2015-12-22T21:11:54Z

src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php

+     *
+     * @return array
+     */
+    protected function setAttribute($data, $attribute, $attributeValue)


What do you think about using the reference operator &$data to avoid useless copy of the array?

You can also add an array type hint.

I prefer to avoid references when possible (http://schlueters.de/blog/archives/125-do-not-use-php-references.html).

Typehint added.

Ok makes sense.

GuilhemN · 2015-12-22T21:23:29Z

👍 to merge this.
Just needs to take a decision about the interface.

GuilhemN · 2015-12-22T22:02:37Z

Sounds good to me
Status: Reviewed

This PR was merged into the 2.7 branch. Discussion ---------- [Serializer] Make metadata interfaces internal | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #17113 (comment) | License | MIT | Doc PR | n/a Introducing such interfaces was a (my) mistake. Serializer metadata are value objects. Nobody will (nor should) implement these interfaces. Composition is better for "extending" metadata. They were not marked as `@api` and should now be marked as `@internal` (or even deprecated but it will cause some maintenance headaches). Commits ------- 3f6cfcd [Serializer] Make metadata interfaces internal

dunglas · 2015-12-30T10:41:24Z

ping @symfony/deciders

Would be nice to merge soon to be able to work on #16143 without creating conflicts.

xabbuh · 2015-12-30T10:48:22Z

src/Symfony/Component/Serializer/Annotation/MaxDepth.php

+
+        if (!is_int($data['value'])) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be an int.', get_class($this)));
+        }


What about also checking that the value is greater than zero?

dunglas · 2016-01-18T21:05:15Z

Status: needs review

ping @symfony/deciders

fabpot · 2016-01-25T13:33:02Z

src/Symfony/Component/Serializer/Mapping/ClassMetadataInterface.php

@@ -41,7 +41,7 @@ public function addAttributeMetadata(AttributeMetadataInterface $attributeMetada
    /**
     * Gets the list of {@link AttributeMetadataInterface}.
     *
-     * @return AttributeMetadataInterface[]
+     * @return @return AttributeMetadataInterface[]


fabpot · 2016-01-25T13:36:14Z

Made some small comments, 👍

dunglas · 2016-01-26T11:19:47Z

Should be ok now.

fabpot · 2016-01-26T12:18:57Z

Thank you @dunglas.

…oNormalize (dunglas) This PR was squashed before being merged into the 3.1 branch (closes #20530). Discussion ---------- [Serializer] Remove AbstractObjectNormalizer::isAttributeToNormalize | Q | A | ------------- | --- | Branch? | 3.1 | Bug fix? | yes | New feature? | no | BC breaks? | unclear | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a I've introduced this method by error in #17113. It has been forgotten during a refactoring. It has always been unused, is not covered by our test suite and has never been documented. Technically it's a BC break (because this is a protected method), but I think that it's better to remove it has it has never be intended to be used, it's just a miss. An alternative is to deprecate it and remove it in v4. Commits ------- fea18aa [Serializer] Remove AbstractObjectNormalizer::isAttributeToNormalize

…, javiereguiluz) This PR was merged into the 3.1 branch. Discussion ---------- [Serializer] Docs for the @MaxDepth annotation Docs for symfony/symfony#17113. Commits ------- d7395d3 Make lines shorter to comply with our soft limit of 80 chars per line 93dcc3f Fix comments 97f48e5 [Serializer] Docs for the @MaxDepth annotation

dunglas added the Serializer label Dec 22, 2015

carsonbot added the Status: Needs Review label Dec 22, 2015

GuilhemN reviewed Dec 22, 2015
View reviewed changes

dunglas mentioned this pull request Dec 22, 2015

[Serializer] Make metadata interfaces internal #17114

Merged

GuilhemN reviewed Dec 22, 2015
View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 22, 2015

dunglas mentioned this pull request Dec 30, 2015

Recursive denormalize using PropertyInfo #16143

Closed

xabbuh reviewed Dec 30, 2015
View reviewed changes

carsonbot added the Status: Needs Work label Jan 11, 2016

GuilhemN mentioned this pull request Jan 14, 2016

Test the format negotiator and reorganize it FriendsOfSymfony/FOSRestBundle#1149

Merged

[Serializer] Add a MaxDepth option

baa35a3

dunglas force-pushed the max_depth branch from ff45c63 to baa35a3 Compare January 18, 2016 16:46

dunglas added 4 commits January 18, 2016 17:50

Update XSD doc

38f562a

Minor changes

23f3ac6

CS fixes

9445fb6

Remove unrelated changes

581abf1

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jan 18, 2016

fabpot reviewed Jan 25, 2016
View reviewed changes

dunglas added 3 commits January 26, 2016 07:42

Fix typo

b6529d4

Debug info

b4cd155

Remove empty

f9a3f88

fabpot closed this in 420989f Jan 26, 2016

dunglas deleted the max_depth branch January 27, 2016 10:57

sroze mentioned this pull request Mar 6, 2016

Introduce a @Depth annotation api-platform/core#104

Closed

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

dunglas mentioned this pull request Jul 4, 2016

Symfony serializer Circular __construct #19232

Closed

dunglas mentioned this pull request Oct 6, 2016

[Serializer] Docs for the @MaxDepth annotation symfony/symfony-docs#7039

Merged

dunglas mentioned this pull request Nov 15, 2016

[Serializer] Remove AbstractObjectNormalizer::isAttributeToNormalize #20530

Closed

digilist mentioned this pull request Dec 15, 2016

[Serializer] MaxDepth annotation not working as expected #20932

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Add a MaxDepth option #17113

[Serializer] Add a MaxDepth option #17113

dunglas commented Dec 22, 2015

GuilhemN Dec 22, 2015

dunglas Dec 22, 2015

dunglas Dec 22, 2015

dunglas Dec 22, 2015

fabpot Dec 26, 2015

GuilhemN Dec 22, 2015

GuilhemN Dec 22, 2015

dunglas Dec 22, 2015

GuilhemN Dec 22, 2015

GuilhemN commented Dec 22, 2015

GuilhemN commented Dec 22, 2015

dunglas commented Dec 30, 2015

xabbuh Dec 30, 2015

dunglas commented Jan 18, 2016

fabpot Jan 25, 2016

fabpot commented Jan 25, 2016

dunglas commented Jan 26, 2016

fabpot commented Jan 26, 2016

[Serializer] Add a MaxDepth option #17113

[Serializer] Add a MaxDepth option #17113

Conversation

dunglas commented Dec 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuilhemN commented Dec 22, 2015

GuilhemN commented Dec 22, 2015

dunglas commented Dec 30, 2015

Choose a reason for hiding this comment

dunglas commented Jan 18, 2016

Choose a reason for hiding this comment

fabpot commented Jan 25, 2016

dunglas commented Jan 26, 2016

fabpot commented Jan 26, 2016