123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168 |
- <?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\ConfigurationInterface;
- use Symfony\Component\Console\Exception\LogicException;
- use Symfony\Component\Console\Input\InputArgument;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Style\SymfonyStyle;
- use Symfony\Component\DependencyInjection\Compiler\ValidateEnvPlaceholdersPass;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
- use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
- use Symfony\Component\Yaml\Yaml;
- /**
- * A console command for dumping available configuration reference.
- *
- * @author Grégoire Pineau <lyrixx@lyrixx.info>
- *
- * @final
- */
- class ConfigDebugCommand extends AbstractConfigCommand
- {
- protected static $defaultName = 'debug:config';
- /**
- * {@inheritdoc}
- */
- protected function configure()
- {
- $this
- ->setDefinition([
- new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
- new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
- ])
- ->setDescription('Dump the current configuration for an extension')
- ->setHelp(<<<'EOF'
- The <info>%command.name%</info> command dumps the current configuration for an
- extension/bundle.
- Either the extension alias or bundle name can be used:
- <info>php %command.full_name% framework</info>
- <info>php %command.full_name% FrameworkBundle</info>
- For dumping a specific option, add its path as second argument:
- <info>php %command.full_name% framework serializer.enabled</info>
- EOF
- )
- ;
- }
- /**
- * {@inheritdoc}
- */
- protected function execute(InputInterface $input, OutputInterface $output): int
- {
- $io = new SymfonyStyle($input, $output);
- $errorIo = $io->getErrorStyle();
- if (null === $name = $input->getArgument('name')) {
- $this->listBundles($errorIo);
- $kernel = $this->getApplication()->getKernel();
- if ($kernel instanceof ExtensionInterface
- && ($kernel instanceof ConfigurationInterface || $kernel instanceof ConfigurationExtensionInterface)
- && $kernel->getAlias()
- ) {
- $errorIo->table(['Kernel Extension'], [[$kernel->getAlias()]]);
- }
- $errorIo->comment('Provide the name of a bundle as the first argument of this command to dump its configuration. (e.g. <comment>debug:config FrameworkBundle</comment>)');
- $errorIo->comment('For dumping a specific option, add its path as the second argument of this command. (e.g. <comment>debug:config FrameworkBundle serializer</comment> to dump the <comment>framework.serializer</comment> configuration)');
- return 0;
- }
- $extension = $this->findExtension($name);
- $container = $this->compileContainer();
- $extensionAlias = $extension->getAlias();
- $extensionConfig = [];
- foreach ($container->getCompilerPassConfig()->getPasses() as $pass) {
- if ($pass instanceof ValidateEnvPlaceholdersPass) {
- $extensionConfig = $pass->getExtensionConfig();
- break;
- }
- }
- if (!isset($extensionConfig[$extensionAlias])) {
- throw new \LogicException(sprintf('The extension with alias "%s" does not have configuration.', $extensionAlias));
- }
- $config = $container->resolveEnvPlaceholders($extensionConfig[$extensionAlias]);
- if (null === $path = $input->getArgument('path')) {
- $io->title(
- sprintf('Current configuration for %s', ($name === $extensionAlias ? sprintf('extension with alias "%s"', $extensionAlias) : sprintf('"%s"', $name)))
- );
- $io->writeln(Yaml::dump([$extensionAlias => $config], 10));
- return 0;
- }
- try {
- $config = $this->getConfigForPath($config, $path, $extensionAlias);
- } catch (LogicException $e) {
- $errorIo->error($e->getMessage());
- return 1;
- }
- $io->title(sprintf('Current configuration for "%s.%s"', $extensionAlias, $path));
- $io->writeln(Yaml::dump($config, 10));
- return 0;
- }
- private function compileContainer(): ContainerBuilder
- {
- $kernel = clone $this->getApplication()->getKernel();
- $kernel->boot();
- $method = new \ReflectionMethod($kernel, 'buildContainer');
- $method->setAccessible(true);
- $container = $method->invoke($kernel);
- $container->getCompiler()->compile($container);
- return $container;
- }
- /**
- * Iterate over configuration until the last step of the given path.
- *
- * @throws LogicException If the configuration does not exist
- *
- * @return mixed
- */
- private function getConfigForPath(array $config, string $path, string $alias)
- {
- $steps = explode('.', $path);
- foreach ($steps as $step) {
- if (!\array_key_exists($step, $config)) {
- throw new LogicException(sprintf('Unable to find configuration for "%s.%s".', $alias, $path));
- }
- $config = $config[$step];
- }
- return $config;
- }
- }
|