[Serializer] Docs for the @MaxDepth annotation #7039

dunglas · 2016-10-06T14:24:50Z

snoek09 · 2016-10-07T07:30:56Z

components/serializer.rst

+        public $foo;
+
+        // ...
+    }


Indent php code block.

snoek09 · 2016-10-07T07:33:27Z

components/serializer.rst

+                    ),
+            ),
+    );
+    */


Add missing .. code-block:: php-annotations.

Actually, just .. code-block:: php

javiereguiluz

👍 a useful feature explained in a clear and concise way. Thanks @dunglas.

lyrixx · 2016-12-07T16:22:30Z

@javiereguiluz Hello. I was playing with the serializer and I did not find the doc on symfony.com. You added your 👍 15 days ago. I think we can merge this one to be able to deploy this new documentation? (It's available since symfony 3.1 ...)

javiereguiluz · 2016-12-07T16:25:25Z

@lyrixx you are so right!! But before merging PRs in Symfony Docs, we need two 👍 from maintainers. So we need that @weaverryan or @xabbuh or @wouterj vote on this too. Thanks!

digilist · 2016-12-12T11:42:48Z

I have a question regarding the max depth. I am not sure if this is desired behavior or a bug. If its the former, we should document this. If its the latter, we should fix the bug (I think it's a bug, but I wanted to ask you before opening an issue).

Consider some code that extends your example code with more levels (4, 5, etc.). By keeping a max depth of 2, the result is the following:

    'foo' => 'level1',
    'child' =>
        array (
            'foo' => 'level2',
            'child' =>
                array (
                    'child' =>
                        array (
                            'child' =>
                                array (
                                    'child' =>
                                        array (
                                            'child' => NULL,
                                        ),
                                ),
                        ),
                ),
        ),
)

As you can see, it considers all child nodes and does not stop after the configured max depths. Only the data of the objects in deeper levels is excluded (attribute foo).

xabbuh · 2016-12-14T19:28:26Z

Thank you Kévin.

…, 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

xabbuh · 2016-12-14T19:29:25Z

@digilist I think best is if you could open an issue on the code repository containing the necessary code to reproduce your issue.

[Serializer] Docs for the @MaxDepth annotation

97f48e5

carsonbot added the Status: Needs Review label Oct 6, 2016

snoek09 reviewed Oct 7, 2016

View reviewed changes

components/serializer.rst

public $foo;

// ...

}

Copy link

snoek09 Oct 7, 2016 •

edited

Loading

Choose a reason for hiding this comment

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

Indent php code block.

snoek09 reviewed Oct 7, 2016

View reviewed changes

Fix comments

93dcc3f

wouterj added this to the 3.1 milestone Nov 9, 2016

Make lines shorter to comply with our soft limit of 80 chars per line

d7395d3

javiereguiluz approved these changes Nov 22, 2016

View reviewed changes

javiereguiluz added Status: Reviewed and removed Status: Needs Review labels Nov 22, 2016

xabbuh merged commit d7395d3 into symfony:3.1 Dec 14, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Docs for the @MaxDepth annotation #7039

[Serializer] Docs for the @MaxDepth annotation #7039

dunglas commented Oct 6, 2016 •

edited

Loading

snoek09 Oct 7, 2016 •

edited

Loading

snoek09 Oct 7, 2016

wouterj Oct 7, 2016

javiereguiluz left a comment

lyrixx commented Dec 7, 2016

javiereguiluz commented Dec 7, 2016

digilist commented Dec 12, 2016 •

edited

Loading

xabbuh commented Dec 14, 2016

xabbuh commented Dec 14, 2016

[Serializer] Docs for the @MaxDepth annotation #7039

[Serializer] Docs for the @MaxDepth annotation #7039

Conversation

dunglas commented Oct 6, 2016 • edited Loading

snoek09 Oct 7, 2016 • edited Loading

Choose a reason for hiding this comment

snoek09 Oct 7, 2016

Choose a reason for hiding this comment

wouterj Oct 7, 2016

Choose a reason for hiding this comment

javiereguiluz left a comment

Choose a reason for hiding this comment

lyrixx commented Dec 7, 2016

javiereguiluz commented Dec 7, 2016

digilist commented Dec 12, 2016 • edited Loading

xabbuh commented Dec 14, 2016

xabbuh commented Dec 14, 2016

dunglas commented Oct 6, 2016 •

edited

Loading

snoek09 Oct 7, 2016 •

edited

Loading

digilist commented Dec 12, 2016 •

edited

Loading