123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155 |
- <?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\Component\Console\Descriptor;
- use Symfony\Component\Console\Application;
- use Symfony\Component\Console\Command\Command;
- use Symfony\Component\Console\Input\InputArgument;
- use Symfony\Component\Console\Input\InputDefinition;
- use Symfony\Component\Console\Input\InputOption;
- /**
- * JSON descriptor.
- *
- * @author Jean-François Simon <contact@jfsimon.fr>
- *
- * @internal
- */
- class JsonDescriptor extends Descriptor
- {
- /**
- * {@inheritdoc}
- */
- protected function describeInputArgument(InputArgument $argument, array $options = [])
- {
- $this->writeData($this->getInputArgumentData($argument), $options);
- }
- /**
- * {@inheritdoc}
- */
- protected function describeInputOption(InputOption $option, array $options = [])
- {
- $this->writeData($this->getInputOptionData($option), $options);
- }
- /**
- * {@inheritdoc}
- */
- protected function describeInputDefinition(InputDefinition $definition, array $options = [])
- {
- $this->writeData($this->getInputDefinitionData($definition), $options);
- }
- /**
- * {@inheritdoc}
- */
- protected function describeCommand(Command $command, array $options = [])
- {
- $this->writeData($this->getCommandData($command), $options);
- }
- /**
- * {@inheritdoc}
- */
- protected function describeApplication(Application $application, array $options = [])
- {
- $describedNamespace = $options['namespace'] ?? null;
- $description = new ApplicationDescription($application, $describedNamespace, true);
- $commands = [];
- foreach ($description->getCommands() as $command) {
- $commands[] = $this->getCommandData($command);
- }
- $data = [];
- if ('UNKNOWN' !== $application->getName()) {
- $data['application']['name'] = $application->getName();
- if ('UNKNOWN' !== $application->getVersion()) {
- $data['application']['version'] = $application->getVersion();
- }
- }
- $data['commands'] = $commands;
- if ($describedNamespace) {
- $data['namespace'] = $describedNamespace;
- } else {
- $data['namespaces'] = array_values($description->getNamespaces());
- }
- $this->writeData($data, $options);
- }
- /**
- * Writes data as json.
- */
- private function writeData(array $data, array $options)
- {
- $flags = $options['json_encoding'] ?? 0;
- $this->write(json_encode($data, $flags));
- }
- private function getInputArgumentData(InputArgument $argument): array
- {
- return [
- 'name' => $argument->getName(),
- 'is_required' => $argument->isRequired(),
- 'is_array' => $argument->isArray(),
- 'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $argument->getDescription()),
- 'default' => \INF === $argument->getDefault() ? 'INF' : $argument->getDefault(),
- ];
- }
- private function getInputOptionData(InputOption $option): array
- {
- return [
- 'name' => '--'.$option->getName(),
- 'shortcut' => $option->getShortcut() ? '-'.str_replace('|', '|-', $option->getShortcut()) : '',
- 'accept_value' => $option->acceptValue(),
- 'is_value_required' => $option->isValueRequired(),
- 'is_multiple' => $option->isArray(),
- 'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $option->getDescription()),
- 'default' => \INF === $option->getDefault() ? 'INF' : $option->getDefault(),
- ];
- }
- private function getInputDefinitionData(InputDefinition $definition): array
- {
- $inputArguments = [];
- foreach ($definition->getArguments() as $name => $argument) {
- $inputArguments[$name] = $this->getInputArgumentData($argument);
- }
- $inputOptions = [];
- foreach ($definition->getOptions() as $name => $option) {
- $inputOptions[$name] = $this->getInputOptionData($option);
- }
- return ['arguments' => $inputArguments, 'options' => $inputOptions];
- }
- private function getCommandData(Command $command): array
- {
- $command->mergeApplicationDefinition(false);
- return [
- 'name' => $command->getName(),
- 'usage' => array_merge([$command->getSynopsis()], $command->getUsages(), $command->getAliases()),
- 'description' => $command->getDescription(),
- 'help' => $command->getProcessedHelp(),
- 'definition' => $this->getInputDefinitionData($command->getDefinition()),
- 'hidden' => $command->isHidden(),
- ];
- }
- }
|