JsonDescriptor.php 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Descriptor;
  11. use Symfony\Component\Console\Application;
  12. use Symfony\Component\Console\Command\Command;
  13. use Symfony\Component\Console\Input\InputArgument;
  14. use Symfony\Component\Console\Input\InputDefinition;
  15. use Symfony\Component\Console\Input\InputOption;
  16. /**
  17. * JSON descriptor.
  18. *
  19. * @author Jean-François Simon <contact@jfsimon.fr>
  20. *
  21. * @internal
  22. */
  23. class JsonDescriptor extends Descriptor
  24. {
  25. /**
  26. * {@inheritdoc}
  27. */
  28. protected function describeInputArgument(InputArgument $argument, array $options = [])
  29. {
  30. $this->writeData($this->getInputArgumentData($argument), $options);
  31. }
  32. /**
  33. * {@inheritdoc}
  34. */
  35. protected function describeInputOption(InputOption $option, array $options = [])
  36. {
  37. $this->writeData($this->getInputOptionData($option), $options);
  38. }
  39. /**
  40. * {@inheritdoc}
  41. */
  42. protected function describeInputDefinition(InputDefinition $definition, array $options = [])
  43. {
  44. $this->writeData($this->getInputDefinitionData($definition), $options);
  45. }
  46. /**
  47. * {@inheritdoc}
  48. */
  49. protected function describeCommand(Command $command, array $options = [])
  50. {
  51. $this->writeData($this->getCommandData($command), $options);
  52. }
  53. /**
  54. * {@inheritdoc}
  55. */
  56. protected function describeApplication(Application $application, array $options = [])
  57. {
  58. $describedNamespace = $options['namespace'] ?? null;
  59. $description = new ApplicationDescription($application, $describedNamespace, true);
  60. $commands = [];
  61. foreach ($description->getCommands() as $command) {
  62. $commands[] = $this->getCommandData($command);
  63. }
  64. $data = [];
  65. if ('UNKNOWN' !== $application->getName()) {
  66. $data['application']['name'] = $application->getName();
  67. if ('UNKNOWN' !== $application->getVersion()) {
  68. $data['application']['version'] = $application->getVersion();
  69. }
  70. }
  71. $data['commands'] = $commands;
  72. if ($describedNamespace) {
  73. $data['namespace'] = $describedNamespace;
  74. } else {
  75. $data['namespaces'] = array_values($description->getNamespaces());
  76. }
  77. $this->writeData($data, $options);
  78. }
  79. /**
  80. * Writes data as json.
  81. */
  82. private function writeData(array $data, array $options)
  83. {
  84. $flags = $options['json_encoding'] ?? 0;
  85. $this->write(json_encode($data, $flags));
  86. }
  87. private function getInputArgumentData(InputArgument $argument): array
  88. {
  89. return [
  90. 'name' => $argument->getName(),
  91. 'is_required' => $argument->isRequired(),
  92. 'is_array' => $argument->isArray(),
  93. 'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $argument->getDescription()),
  94. 'default' => \INF === $argument->getDefault() ? 'INF' : $argument->getDefault(),
  95. ];
  96. }
  97. private function getInputOptionData(InputOption $option): array
  98. {
  99. return [
  100. 'name' => '--'.$option->getName(),
  101. 'shortcut' => $option->getShortcut() ? '-'.str_replace('|', '|-', $option->getShortcut()) : '',
  102. 'accept_value' => $option->acceptValue(),
  103. 'is_value_required' => $option->isValueRequired(),
  104. 'is_multiple' => $option->isArray(),
  105. 'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $option->getDescription()),
  106. 'default' => \INF === $option->getDefault() ? 'INF' : $option->getDefault(),
  107. ];
  108. }
  109. private function getInputDefinitionData(InputDefinition $definition): array
  110. {
  111. $inputArguments = [];
  112. foreach ($definition->getArguments() as $name => $argument) {
  113. $inputArguments[$name] = $this->getInputArgumentData($argument);
  114. }
  115. $inputOptions = [];
  116. foreach ($definition->getOptions() as $name => $option) {
  117. $inputOptions[$name] = $this->getInputOptionData($option);
  118. }
  119. return ['arguments' => $inputArguments, 'options' => $inputOptions];
  120. }
  121. private function getCommandData(Command $command): array
  122. {
  123. $command->mergeApplicationDefinition(false);
  124. return [
  125. 'name' => $command->getName(),
  126. 'usage' => array_merge([$command->getSynopsis()], $command->getUsages(), $command->getAliases()),
  127. 'description' => $command->getDescription(),
  128. 'help' => $command->getProcessedHelp(),
  129. 'definition' => $this->getInputDefinitionData($command->getDefinition()),
  130. 'hidden' => $command->isHidden(),
  131. ];
  132. }
  133. }