8000 [FrameworkBundle] Enable replacing of services by canni · Pull Request #7040 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[FrameworkBundle] Enable replacing of services #7040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[FrameworkBundle] Enable replacing of services #7040

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89bac11
[FrameworkBundle] Allow overriding of services IDs
canni Feb 10, 2013
93cf651
Add unit tests
canni Feb 10, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/ServiceReplacementsPass.php
View file
Open in desktop
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\Alias;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;

/**
* Overwrites a service with an alias to a new service.
*
* @author Dariusz Górecki <darek.krk@gmail.com>
* @author Christophe Coevoet <stof@notk.org>
*/
class ServiceReplacementsPass implements CompilerPassInterface
{
/**
* {@inheritDoc}
*/
public function process(ContainerBuilder $container)
{
$replacements = array();

foreach ($container->findTaggedServiceIds('framework.service_replacer') as $serviceId => $tag) {
if (!isset($tag[0]['replaces'])) {
continue;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe it's better to throw exception here?

}

$oldId = $tag[0]['replaces'];
$newId = isset($tag[0]['renameTo'])
? $tag[0]['renameTo']
: $oldId.'.orig';

if ($container->hasAlias($oldId)) {
// Service we're overwriting is an alias.
// Register a private alias for this service to inject it as the parent
$container->setAlias($newId, new Alias($oldId, false));
} else {
// Service we're overwriting is a definition.
// Register it again as a private service to inject it as the parent.
$definition = $container->getDefinition($oldId);
$definition->setPublic(false);
// Replacing definition should be properly tagged
// so it's processed instead of old one.
// Old service looses their tags.
$definition->clearTags();
$container->setDefinition($newId, $definition);
}

$container->setAlias($oldId, $serviceId);
}
}
}
2 changes: 2 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationExtractorPass;
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationDumperPass;
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\FragmentRendererPass;
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ServiceReplacementsPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\PassConfig;
use Symfony\Component\DependencyInjection\Scope;
Expand Down Expand Up @@ -54,6 +55,7 @@ public function build(ContainerBuilder $container)

$container->addScope(new Scope('request'));

$container->addCompilerPass(new ServiceReplacementsPass());
$container->addCompilerPass(new RoutingResolverPass());
$container->addCompilerPass(new ProfilerPass());
$container->addCompilerPass(new RegisterKernelListenersPass(), PassConfig::TYPE_AFTER_REMOVING);
Expand Down
176 changes: 176 additions & 0 deletions ...Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/ServiceReplacementsPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<?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\Alias;
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ServiceReplacementsPass;

class ServiceReplacementsPassTest extends \PHPUnit_Framework_TestCase
{
public function testReplacemntOfAlias()
{
$service = array(
'my_replacemnt.service' => array(0 => array('replaces' => 'service.alias')),
);

$alias = new Alias('service.alias', false);
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder');

$container->expects($this->once())
->method('findTaggedServiceIds')
->with('framework.service_replacer')
->will($this->returnValue($service));
$container->expects($this->once())
->method('hasAlias')
->with('service.alias')
->will($this->returnValue(true));
$container->expects($this->at(2))
->method('setAlias')
->with(
'service.alias.orig', $alias
);
$container->expects($this->at(3))
->method('setAlias')
->with(
'service.alias', 'my_replacemnt.service'
);

$pass = new ServiceReplacementsPass();
$pass->process($container);
}

public function testReplacemntOfAliasWithRename()
{
$service = array(
'my_replacemnt.service' => array(0 => array(
'replaces' => 'service.alias',
'renameTo' => 'old.service.alias',
)),
);

$alias = new Alias('service.alias', false);
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder');

$container->expects($this->once())
->method('findTaggedServiceIds')
->with('framework.service_replacer')
->will($this->returnValue($service));
$container->expects($this->once())
->method('hasAlias')
->with('service.alias')
->will($this->returnValue(true));
$container->expects($this->at(2))
->method('setAlias')
->with(
'old.service.alias', $alias
);
$container->expects($this->at(3))
->method('setAlias')
->with(
'service.alias', 'my_replacemnt.service'
);

$pass = new ServiceReplacementsPass();
$pass->process($container);
}

public function testReplacemntOfService()
{
$service = array(
'my_replacemnt.service' => array(0 => array('replaces' => 'service.to.replace')),
);

$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder');
$definition = $this->getMock('Symfony\Component\DependencyInjection\Definition', array(
'clearTags', 'setPublic'
), array('service.to.replace'));

$container->expects($this->once())
->method('findTaggedServiceIds')
->with('framework.service_replacer')
->will($this->returnValue($service));
$container->expects($this->once())
->method('hasAlias')
->with('service.to.replace')
->will($this->returnValue(false));
$container->expects($this->once())
->method('getDefinition')
->with('service.to.replace')
->will($this->returnValue($definition));
$container->expects($this->once())
->method('setDefinition')
->with(
'service.to.replace.orig', $definition
);
$container->expects($this->once())
->method('setAlias')
->with(
'service.to.replace', 'my_replacemnt.service'
);

$definition->expects($this->once())
->method('setPublic')
->with(false);
$definition->expects($this->once())
->method('clearTags');

$pass = new ServiceReplacementsPass();
$pass->process($container);
}

public function testReplacemntOfServiceWithRename()
{
$service = array(
'my_replacemnt.service' => array(0 => array(
'replaces' => 'service.to.replace',
'renameTo' => 'old.service.to.replace'
)),
);

$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder');
$definition = $this->getMock('Symfony\Component\DependencyInjection\Definition', array(
'clearTags', 'setPublic'
), array('service.to.replace'));

$container->expects($this->once())
->method('findTaggedServiceIds')
->with('framework.service_replacer')
->will($this->returnValue($service));
$container->expects($this->once())
->method('hasAlias')
->with('service.to.replace')
->will($this->returnValue(false));
$container->expects($this->once())
->method('getDefinition')
->with('service.to.replace')
->will($this->returnValue($definition));
$container->expects($this->once())
->method('setDefinition')
->with(
'old.service.to.replace', $definition
);
$container->expects($this->once())
->method('setAlias')
->with(
'service.to.replace', 'my_replacemnt.service'
);

$definition->expects($this->once())
->method('setPublic')
->with(false);
$definition->expects($this->once())
->method('clearTags');

$pass = new ServiceReplacementsPass();
$pass->process($container);
}
}
0