Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FrameworkBundle] Adds the possibility to register Commands via the DIC
- Loading branch information
Showing
7 changed files
with
198 additions
and
3 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
49 changes: 49 additions & 0 deletions
49
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/AddConsoleCommandPass.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,49 @@ | ||
<?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\Compiler\CompilerPassInterface; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
/** | ||
* AddConsoleCommandPass. | ||
* | ||
* @author Grégoire Pineau <lyrixx@lyrixx.info> | ||
*/ | ||
class AddConsoleCommandPass implements CompilerPassInterface | ||
{ | ||
public function process(ContainerBuilder $container) | ||
{ | ||
$commandServices = $container->findTaggedServiceIds('console.command'); | ||
|
||
foreach ($commandServices as $id => $tags) { | ||
$definition = $container->getDefinition($id); | ||
|
||
if (!$definition->isPublic()) { | ||
throw new \InvalidArgumentException(sprintf('The service "%s" tagged "console.command" must be public.', $id)); | ||
} | ||
|
||
if ($definition->isAbstract()) { | ||
throw new \InvalidArgumentException(sprintf('The service "%s" tagged "console.command" must not be abstract.', $id)); | ||
} | ||
|
||
$class = $container->getParameterBag()->resolveValue($definition->getClass()); | ||
$r = new \ReflectionClass($class); | ||
if (!$r->isSubclassOf('Symfony\\Component\\Console\\Command\\Command')) { | ||
throw new \InvalidArgumentException(sprintf('The service "%s" tagged "console.command" must be a subclass of "Symfony\\Component\\Console\\Command\\Command".', $id)); | ||
} | ||
$container->setAlias('console.command.'.strtolower(str_replace('\\', '_', $class)), $id); | ||
} | ||
|
||
$container->setParameter('console.command.ids', array_keys($commandServices)); | ||
} | ||
} |
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
96 changes: 96 additions & 0 deletions
96
...y/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/AddConsoleCommandPassTest.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,96 @@ | ||
<?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\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddConsoleCommandPass; | ||
use Symfony\Component\Console\Command\Command; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
use Symfony\Component\DependencyInjection\Definition; | ||
use Symfony\Component\DependencyInjection\Reference; | ||
|
||
class AddConsoleCommandPassTest extends \PHPUnit_Framework_TestCase | ||
{ | ||
public function testProcess() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->addCompilerPass(new AddConsoleCommandPass()); | ||
$container->setParameter('my-command.class', 'Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\Compiler\MyCommand'); | ||
|
||
$definition = new Definition('%my-command.class%'); | ||
$definition->addTag('console.command'); | ||
$container->setDefinition('my-command', $definition); | ||
|
||
$container->compile(); | ||
|
||
$alias = 'console.command.symfony_bundle_frameworkbundle_tests_dependencyinjection_compiler_mycommand'; | ||
$this->assertTrue($container->hasAlias($alias)); | ||
$this->assertSame('my-command', (string) $container->getAlias($alias)); | ||
|
||
$this->assertTrue($container->hasParameter('console.command.ids')); | ||
$this->assertSame(array('my-command'), $container->getParameter('console.command.ids')); | ||
} | ||
|
||
/** | ||
* @expectedException InvalidArgumentException | ||
* @expectedExceptionMessage The service "my-command" tagged "console.command" must be public. | ||
*/ | ||
public function testProcessThrowAnExceptionIfTheServiceIsNotPublic() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->addCompilerPass(new AddConsoleCommandPass()); | ||
|
||
$definition = new Definition('Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\Compiler\MyCommand'); | ||
$definition->addTag('console.command'); | ||
$definition->setPublic(false); | ||
$container->setDefinition('my-command', $definition); | ||
|
||
$container->compile(); | ||
} | ||
|
||
/** | ||
* @expectedException InvalidArgumentException | ||
* @expectedExceptionMessage The service "my-command" tagged "console.command" must not be abstract. | ||
*/ | ||
public function testProcessThrowAnExceptionIfTheServiceIsAbstract() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->addCompilerPass(new AddConsoleCommandPass()); | ||
|
||
$definition = new Definition('Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\Compiler\MyCommand'); | ||
$definition->addTag('console.command'); | ||
$definition->setAbstract(true); | ||
$container->setDefinition('my-command', $definition); | ||
|
||
$container->compile(); | ||
} | ||
|
||
/** | ||
* @expectedException InvalidArgumentException | ||
* @expectedExceptionMessage The service "my-command" tagged "console.command" must be a subclass of "Symfony\Component\Console\Command\Command". | ||
*/ | ||
public function testProcessThrowAnExceptionIfTheServiceIsNotASubclassOfCommand() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->addCompilerPass(new AddConsoleCommandPass()); | ||
|
||
$definition = new Definition('SplObjectStorage'); | ||
$definition->addTag('console.command'); | ||
$container->setDefinition('my-command', $definition); | ||
|
||
$container->compile(); | ||
} | ||
} | ||
|
||
class MyCommand extends Command | ||
{ | ||
|
||
} |
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