-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
216 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/SerializerPass.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler; | ||
|
||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
use Symfony\Component\DependencyInjection\Reference; | ||
|
||
/** | ||
* Adds all services with the tags "serializer.encoder" and "serializer.normalizer" as | ||
* encoders and normalizers to the Serializer service. | ||
* | ||
* @author Javier Lopez <f12loalf@gmail.com> | ||
*/ | ||
class SerializerPass implements CompilerPassInterface | ||
{ | ||
public function process(ContainerBuilder $container) | ||
{ | ||
if (!$container->hasDefinition('serializer')) { | ||
This comment has been minimized.
Sorry, something went wrong. |
||
return; | ||
} | ||
|
||
// Looks for all the services tagged "serializer.normalizer" and adds them to the Serializer service | ||
$normalizers = $this->findAndSortTaggedServices('serializer.normalizer', $container); | ||
$container->getDefinition('serializer')->replaceArgument(0, $normalizers); | ||
|
||
// Looks for all the services tagged "serializer.encoders" and adds them to the Serializer service | ||
$encoders = $this->findAndSortTaggedServices('serializer.encoder', $container); | ||
$container->getDefinition('serializer')->replaceArgument(1, $encoders); | ||
} | ||
|
||
private function findAndSortTaggedServices($tagName, ContainerBuilder $container) | ||
{ | ||
$services = $container->findTaggedServiceIds($tagName); | ||
|
||
if (empty($services)) { | ||
throw new \RuntimeException(sprintf('You must tag at least one service as "%s" to use the Serializer service', $tagName)); | ||
} | ||
|
||
$sortedServices = array(); | ||
foreach ($services as $serviceId => $tags) { | ||
foreach ($tags as $tag) { | ||
$priority = isset($tag['priority']) ? $tag['priority'] : 0; | ||
$sortedServices[$priority][] = new Reference($serviceId); | ||
This comment has been minimized.
Sorry, something went wrong.
Taluu
Contributor
|
||
} | ||
} | ||
|
||
krsort($sortedServices); | ||
|
||
// Flatten the array | ||
return call_user_func_array('array_merge', $sortedServices); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<?xml version="1.0" ?> | ||
|
||
<container xmlns="http://symfony.com/schema/dic/services" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> | ||
|
||
<parameters> | ||
<parameter key="serializer.class">Symfony\Component\Serializer\Serializer</parameter> | ||
<parameter key="serializer.encoder.xml.class">Symfony\Component\Serializer\Encoder\XmlEncoder</parameter> | ||
<parameter key="serializer.encoder.json.class">Symfony\Component\Serializer\Encoder\JsonEncoder</parameter> | ||
</parameters> | ||
|
||
<services> | ||
<service id="serializer" class="%serializer.class%" > | ||
<argument type="collection" /> | ||
<argument type="collection" /> | ||
</service> | ||
<!-- Encoders --> | ||
<service id="serializer.encoder.xml" class="%serializer.encoder.xml.class%" public="false" > | ||
<tag name="serializer.encoder" /> | ||
</service> | ||
<service id="serializer.encoder.json" class="%serializer.encoder.json.class%" public="false" > | ||
<tag name="serializer.encoder" /> | ||
</service> | ||
</services> | ||
</container> |
105 changes: 105 additions & 0 deletions
105
src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/SerializerPassTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\Compiler; | ||
|
||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
use Symfony\Component\DependencyInjection\Reference; | ||
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\SerializerPass; | ||
|
||
/** | ||
* Tests for the SerializerPass class | ||
* | ||
* @author Javier Lopez <f12loalf@gmail.com> | ||
*/ | ||
class SerializerPassTest extends \PHPUnit_Framework_TestCase | ||
{ | ||
|
||
public function testThrowExceptionWhenNoNormalizers() | ||
{ | ||
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder'); | ||
|
||
$container->expects($this->once()) | ||
->method('hasDefinition') | ||
->with('serializer') | ||
->will($this->returnValue(true)); | ||
|
||
$container->expects($this->once()) | ||
->method('findTaggedServiceIds') | ||
->with('serializer.normalizer') | ||
->will($this->returnValue(array())); | ||
|
||
$this->setExpectedException('RuntimeException'); | ||
|
||
$serializerPass = new SerializerPass(); | ||
$serializerPass->process($container); | ||
} | ||
|
||
public function testThrowExceptionWhenNoEncoders() | ||
{ | ||
$definition = $this->getMock('Symfony\Component\DependencyInjection\Definition'); | ||
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder'); | ||
|
||
$container->expects($this->once()) | ||
->method('hasDefinition') | ||
->with('serializer') | ||
->will($this->returnValue(true)); | ||
|
||
$container->expects($this->any()) | ||
->method('findTaggedServiceIds') | ||
->will($this->onConsecutiveCalls( | ||
array('n' => array('serializer.normalizer')), | ||
array() | ||
)); | ||
|
||
$container->expects($this->once()) | ||
->method('getDefinition') | ||
->will($this->returnValue($definition)); | ||
|
||
$this->setExpectedException('RuntimeException'); | ||
|
||
$serializerPass = new SerializerPass(); | ||
$serializerPass->process($container); | ||
} | ||
|
||
public function testServicesAreOrderedAccordingToPriority() | ||
{ | ||
$services = array( | ||
'n3' => array('tag' => array()), | ||
'n1' => array('tag' => array('priority' => 200)), | ||
'n2' => array('tag' => array('priority' => 100)) | ||
); | ||
|
||
$expected = array( | ||
new Reference('n1'), | ||
new Reference('n2'), | ||
new Reference('n3') | ||
); | ||
|
||
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder'); | ||
|
||
$container->expects($this->atLeastOnce()) | ||
->method('findTaggedServiceIds') | ||
->will($this->returnValue($services)); | ||
|
||
$serializerPass = new SerializerPass(); | ||
|
||
$method = new \ReflectionMethod( | ||
'Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\SerializerPass', | ||
'findAndSortTaggedServices' | ||
); | ||
$method->setAccessible(TRUE); | ||
|
||
$actual = $method->invoke($serializerPass, 'tag', $container); | ||
|
||
$this->assertEquals($expected, $actual); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
You might want to check for the actual class of that service as someone might define his own serializer service, and not use the Symfony component.
As a workaround something like this is currently necessary: