143 lines
4.9 KiB
PHP
143 lines
4.9 KiB
PHP
<?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\Command;
|
|
|
|
use Symfony\Component\Config\Definition\Dumper\YamlReferenceDumper;
|
|
use Symfony\Component\Config\Definition\Dumper\XmlReferenceDumper;
|
|
use Symfony\Component\Console\Input\InputArgument;
|
|
use Symfony\Component\Console\Input\InputOption;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
|
|
|
/**
|
|
* A console command for dumping available configuration reference
|
|
*
|
|
* @author Kevin Bond <kevinbond@gmail.com>
|
|
* @author Wouter J <waldio.webdesign@gmail.com>
|
|
*/
|
|
class ConfigDumpReferenceCommand extends ContainerDebugCommand
|
|
{
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function configure()
|
|
{
|
|
$this
|
|
->setName('config:dump-reference')
|
|
->setDefinition(array(
|
|
new InputArgument('name', InputArgument::OPTIONAL, 'The Bundle name or the extension alias'),
|
|
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The format, either yaml or xml', 'yaml'),
|
|
))
|
|
->setDescription('Dumps the default configuration for an extension')
|
|
->setHelp(<<<EOF
|
|
The <info>%command.name%</info> command dumps the default configuration for an
|
|
extension/bundle.
|
|
|
|
The extension alias or bundle name can be used:
|
|
|
|
<info>php %command.full_name% framework</info>
|
|
<info>php %command.full_name% FrameworkBundle</info>
|
|
|
|
With the <info>format</info> option specifies the format of the configuration,
|
|
this is either <comment>yaml</comment> or <comment>xml</comment>. When the option is not provided, <comment>yaml</comment> is used.
|
|
EOF
|
|
)
|
|
;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*
|
|
* @throws \LogicException
|
|
*/
|
|
protected function execute(InputInterface $input, OutputInterface $output)
|
|
{
|
|
$bundles = $this->getContainer()->get('kernel')->getBundles();
|
|
$containerBuilder = $this->getContainerBuilder();
|
|
|
|
$name = $input->getArgument('name');
|
|
|
|
if (empty($name)) {
|
|
$output->writeln('Available registered bundles with their extension alias if available:');
|
|
|
|
$table = $this->getHelperSet()->get('table');
|
|
$table->setHeaders(array('Bundle name', 'Extension alias'));
|
|
foreach ($bundles as $bundle) {
|
|
$extension = $bundle->getContainerExtension();
|
|
$table->addRow(array($bundle->getName(), $extension ? $extension->getAlias() : ''));
|
|
}
|
|
$table->render($output);
|
|
|
|
return;
|
|
}
|
|
|
|
$extension = null;
|
|
|
|
if (preg_match('/Bundle$/', $name)) {
|
|
// input is bundle name
|
|
|
|
if (isset($bundles[$name])) {
|
|
$extension = $bundles[$name]->getContainerExtension();
|
|
}
|
|
|
|
if (!$extension) {
|
|
throw new \LogicException(sprintf('No extensions with configuration available for "%s"', $name));
|
|
}
|
|
|
|
$message = 'Default configuration for "'.$name.'"';
|
|
} else {
|
|
foreach ($bundles as $bundle) {
|
|
$extension = $bundle->getContainerExtension();
|
|
|
|
if ($extension && $extension->getAlias() === $name) {
|
|
break;
|
|
}
|
|
|
|
$extension = null;
|
|
}
|
|
|
|
if (!$extension) {
|
|
throw new \LogicException(sprintf('No extension with alias "%s" is enabled', $name));
|
|
}
|
|
|
|
$message = 'Default configuration for extension with alias: "'.$name.'"';
|
|
}
|
|
|
|
$configuration = $extension->getConfiguration(array(), $containerBuilder);
|
|
|
|
if (!$configuration) {
|
|
throw new \LogicException(sprintf('The extension with alias "%s" does not have it\'s getConfiguration() method setup', $extension->getAlias()));
|
|
}
|
|
|
|
if (!$configuration instanceof ConfigurationInterface) {
|
|
throw new \LogicException(sprintf('Configuration class "%s" should implement ConfigurationInterface in order to be dumpable', get_class($configuration)));
|
|
}
|
|
|
|
switch ($input->getOption('format')) {
|
|
case 'yaml':
|
|
$output->writeln(sprintf('# %s', $message));
|
|
$dumper = new YamlReferenceDumper();
|
|
break;
|
|
case 'xml':
|
|
$output->writeln(sprintf('<!-- %s -->', $message));
|
|
$dumper = new XmlReferenceDumper();
|
|
break;
|
|
default:
|
|
$output->writeln($message);
|
|
throw new \InvalidArgumentException('Only the yaml and xml formats are supported.');
|
|
}
|
|
|
|
$output->writeln($dumper->dump($configuration), $extension->getNamespace());
|
|
}
|
|
}
|