[2.2] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle #5347

loalf · 2012-08-25T21:35:38Z

It looks like the Serializer service is not in the Service Container. This PR allows users to get this service through the DIC by just simple doing $container->get('serializer');

Also, by default, the Framework Bundle will load a couple of encoders (JSON and XML) and one normalizer (GetSetMethodNormalizar). If the user wants to add more encoders or normalizer he will just have to tag it, using the specials tags "serializer.encoder" and "serializer.normalizer".

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Symfony2 tests pass: yes
Fixes the following tickets: [comma separated list of tickets fixed by the PR]
Todo: If this PR is approved then this file
https://github.com/symfony/symfony-standard/blob/master/app/config/config.yml
should be modified for something like this
https://gist.github.com/3471185
License of the code: MIT

…rvices

travisbot · 2012-08-25T21:42:38Z

This pull request fails (merged 881e9a6 into d1be451).

pborreli · 2012-08-25T22:46:19Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/SerializerPass.php

+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Reference;
+/**


empty line is needed here

loalf · 2012-08-26T00:07:05Z

I´ve got rid of the priorities as they seem to confusing.

@stof Do I still need at least one normalizer to set up the Serializer service?

travisbot · 2012-08-26T00:10:32Z

This pull request fails (merged 0278df8 into d1be451).

stof · 2012-08-26T02:59:10Z

Priorities are needed IMO as the order of normalizers is relevant (the first one supporting it is used). But they should behave in the same way than in all other parts of Symfony.

loalf · 2012-08-26T21:08:46Z

@stof could you please show what those parts are so I can use them as a reference to implement that feature in this PR. Thanks.

stof · 2012-08-26T21:40:19Z

@loalf the registration of listeners for instance

loalf · 2012-08-29T21:44:29Z

@stof I guess you mean this implementation, https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/RegisterKernelListenersPass.php, no?

I´ve taken a look at this code and it does pretty much the same thing it did in my previous code so I wonder if when you say "they should behave in the same way than in all other parts of Symfony" you actually mean adding a couple of methods in the Serializer service (https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Serializer/Serializer.php), namely, Serializer::addNormalizer($normalizer, $priority) and Serializer::addEncoder($encoder, $priority) to be used by the CompilerPass.

stof · 2012-08-29T23:03:48Z

@loalf no. You previous implementation was allowing only one reference for each priority (and so you had to keep an counter for the guessed priority) whereas the existing code uses an array for each priority to have several ones.

And no, you don't need to handle the priority in the Serializer IMO. when configuring the serializer by hand, you control the registration order. The priority in tags is needed to control it, but it can be sorted at compile time.

loalf · 2012-09-03T20:01:02Z

Sorry for the long delay to reply to this.

There is one thing I am not still happy with. I created a private method, findAndSortTaggedServices, in the SerializerCompiler class but, to be honest, I think this method should be on the Container class so everyone could benefit of this feature. Any comment?

stof · 2012-09-03T20:05:30Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/SerializerPass.php

+
+        // Flatten the array
+        $services = array();
+        array_walk_recursive($servs, function($a) use (&$services) { $services[] = $a; });


if (!empty($servs)) { $services = call_user_fun_array('array_merge', $servs); }

What´s that for?

A way to do it more efficiently and without having to use the array by reference (and used in some other places)

nice trick!

travisbot · 2012-09-03T20:40:19Z

This pull request passes (merged e579aac into d1be451).

travisbot · 2012-09-03T21:03:38Z

This pull request passes (merged 91812e2 into d1be451).

travisbot · 2012-09-03T21:46:30Z

This pull request passes (merged 4d6fdc0 into d1be451).

stof · 2012-10-13T20:37:02Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/SerializerPass.php

+        $container->getDefinition('serializer')->replaceArgument(1, $encoders);
+    }
+
+    private function findAndSortTaggedServices($tag_name, $container)


Please use camelCased names for variables

and you should typehint the ContainerBuilder

stof · 2012-10-29T20:48:29Z

@loalf IMO, you should keep the service definition, but add the tag only based on a config flag (enabled by default to make it easier to use for simple cases but allowing to disable this normalizer)

framework:
    serializer:
        enabled: true
        get_set_normalizer: false

loalf · 2012-11-04T19:13:18Z

@stof Honestly, I don't like this kind of "magic". Since you only have to create a new service and tag it properly, what's the point of overengineering the code just for this normalizer? Why not treat it as any other normalizer/serializer you may want to load and make it explicit and transparent? @fabpot

By the way, my apologies about the long delays in my responses. I've been a little bit busy lately.

stof · 2012-11-04T19:49:34Z

@loalf The point is, your current setup requires registering a normalizer to be usable. With my suggestion, the serializer would be usable directly (when you don't have circular references in your object graph) but you would still be able to remove the GetSetNormalizer if you don't want to use it (for instance for the case where you have circular references)

loalf · 2012-11-04T20:47:04Z

@stof ok, I do get it. The thing is I am not a big fun of ad hoc solutions when there is already a standard way to load a normalizer (tagging it).

As you said, the current setup is unusable unless you register at least one normalizer so, what about throwing an exception in the SerializerPass class if there aren't any normalizer/encoder registered?

…izer_in_dic

loalf · 2012-11-13T20:29:54Z

@stof @fabpot any thoughts on this?

fabpot · 2012-12-14T12:28:33Z

I agree with @loalf: no tagged services by default and an exception if none are.

Conflicts: src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

…tagged

…ializer_in_dic

fabpot · 2013-01-09T08:31:10Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

 * A new parameter has been added to the DIC: `router.request_context.base_url`
   You can customize it for your functional tests or for generating urls with
   the right base url when your are in the cli context.
+>>>>>>> master


merge conflict resolution problem.

fabpot · 2013-01-09T08:35:45Z

@loalf Can you take my comments into account, squash your commits, and submit a PR for the docs? Thanks.

Conflicts: src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

loalf · 2013-01-19T20:27:03Z

This is the link to the PR for the docs, https://github.com/symfony/symfony-docs/pull/1829/files, is that enough?

loalf · 2013-01-20T18:45:32Z

Please, close this PR and carry on #6815

This PR is related to this one symfony/symfony#5347.

This PR was merged into the master branch. Discussion ---------- [2.3] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle This PR is the same as symfony#5347 but since I am struggling to squash all the commits I better create a new one. Sorry for the inconveniences, :) Commits ------- b4e4844 Add the serializer service

This PR was merged into the 2.6-dev branch. Discussion ---------- [Serializer] Handle circular references | Q | A | ------------- | --- | Bug fix? | Yes: avoid infinite loops. Allows to improve #5347 | New feature? | yes (circular reference handler) | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT | Doc PR | symfony/symfony-docs#4299 This PR adds handling of circular references in the `Serializer` component. The number of allowed iterations is configurable (one by default). The behavior when a circular reference is detected is configurable. By default an exception is thrown. Instead of throwing an exception, it's possible to register a custom handler (e.g.: a Doctrine Handler returning the object ID). Usage: ```php use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer; use Symfony\Component\Serializer\Serializer; class MyObj { private $id = 1312; public function getId() { return $this->getId(); } public function getMe() { return $this; } } $normalizer = new GetSetMethodNormalizer(); $normalizer->setCircularReferenceLimit(3); $normalizer->setCircularReferenceHandler(function ($obj) { return $obj->getId(); }); $serializer = new Serializer([$normalizer]); $serializer->normalize(new MyObj()); ``` Commits ------- 48491c4 [Serializer] Handle circular references

This PR was merged into the 2.6-dev branch. Discussion ---------- [Serializer] Handle circular references | Q | A | ------------- | --- | Bug fix? | Yes: avoid infinite loops. Allows to improve symfony#5347 | New feature? | yes (circular reference handler) | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT | Doc PR | symfony/symfony-docs#4299 This PR adds handling of circular references in the `Serializer` component. The number of allowed iterations is configurable (one by default). The behavior when a circular reference is detected is configurable. By default an exception is thrown. Instead of throwing an exception, it's possible to register a custom handler (e.g.: a Doctrine Handler returning the object ID). Usage: ```php use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer; use Symfony\Component\Serializer\Serializer; class MyObj { private $id = 1312; public function getId() { return $this->getId(); } public function getMe() { return $this; } } $normalizer = new GetSetMethodNormalizer(); $normalizer->setCircularReferenceLimit(3); $normalizer->setCircularReferenceHandler(function ($obj) { return $obj->getId(); }); $serializer = new Serializer([$normalizer]); $serializer->normalize(new MyObj()); ``` Commits ------- 48491c4 [Serializer] Handle circular references

humandb added 5 commits August 25, 2012 19:32

Adding the Serializer service to the Framework Bundle

ca250b0

Adding the Compiler Pass to add encoders and normalizers as tagged se…

0b51471

…rvices

Fixing some issues with SerializerPass

7b791fe

Now it sorts the encoders and normalizers depending on its priority

fb1685c

Updated serializer.xml

881e9a6

pborreli reviewed Aug 25, 2012
View reviewed changes

Getting rid of the priorities

0278df8

Added priority to the services according to the Symfony standards

e579aac

stof reviewed Sep 3, 2012
View reviewed changes

Iterating through all the tags on the service

91812e2

Simplyfing the way to flatten the array acording to @stof comments

4d6fdc0

stof reviewed Oct 13, 2012
View reviewed changes

Merge branch 'master' of git://github.com/symfony/symfony into serial…

b46d4e9

…izer_in_dic

humandb added 4 commits December 16, 2012 19:03

Merge branch 'master' into serializer_in_dic

377aa31

Conflicts: src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

SerializerPass throws an exception if no encoders or normalizers are …

731a05e

…tagged

Adding functional testing for the SerializerPass class

627b69c

Merge branch 'serializer_in_dic' of github.com:loalf/symfony into ser…

122ac5c

…ializer_in_dic

fabpot reviewed Jan 9, 2013
View reviewed changes

humandb added 2 commits January 19, 2013 20:10

Merge branch 'master' into serializer_in_dic

2fbd210

Conflicts: src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

Fixed minor issues

8cb0564

loalf mentioned this pull request Jan 20, 2013

[2.3] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle #6815

Merged

fabpot closed this Jan 20, 2013

77web pushed a commit to 77web/symfony-docs that referenced this pull request Nov 23, 2013

Update reference/configuration/framework.rst

c01bc53

This PR is related to this one symfony/symfony#5347.

dunglas mentioned this pull request Oct 2, 2014

[Serializer] Handle circular references #12098

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.2] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle #5347

[2.2] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle #5347

loalf commented Aug 25, 2012

travisbot commented Aug 25, 2012

pborreli Aug 25, 2012

loalf commented Aug 26, 2012

travisbot commented Aug 26, 2012

stof commented Aug 26, 2012

loalf commented Aug 26, 2012

stof commented Aug 26, 2012

loalf commented Aug 29, 2012

stof commented Aug 29, 2012

loalf commented Sep 3, 2012

stof Sep 3, 2012

loalf Sep 3, 2012

stof Sep 3, 2012

loalf Sep 3, 2012

travisbot commented Sep 3, 2012

travisbot commented Sep 3, 2012

travisbot commented Sep 3, 2012

stof Oct 13, 2012

stof Oct 13, 2012

stof commented Oct 29, 2012

loalf commented Nov 4, 2012

stof commented Nov 4, 2012

loalf commented Nov 4, 2012

loalf commented Nov 13, 2012

fabpot commented Dec 14, 2012

fabpot Jan 9, 2013

fabpot commented Jan 9, 2013

loalf commented Jan 19, 2013

loalf commented Jan 20, 2013

[2.2] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle #5347

[2.2] [FrameworkBundle] [Serializer] Loads the Serializer component as a service in the Framework Bundle #5347

Conversation

loalf commented Aug 25, 2012

travisbot commented Aug 25, 2012

Choose a reason for hiding this comment

loalf commented Aug 26, 2012

travisbot commented Aug 26, 2012

stof commented Aug 26, 2012

loalf commented Aug 26, 2012

stof commented Aug 26, 2012

loalf commented Aug 29, 2012

stof commented Aug 29, 2012

loalf commented Sep 3, 2012

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

travisbot commented Sep 3, 2012

travisbot commented Sep 3, 2012

travisbot commented Sep 3, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Oct 29, 2012

loalf commented Nov 4, 2012

stof commented Nov 4, 2012

loalf commented Nov 4, 2012

loalf commented Nov 13, 2012

fabpot commented Dec 14, 2012

Choose a reason for hiding this comment

fabpot commented Jan 9, 2013

loalf commented Jan 19, 2013

loalf commented Jan 20, 2013