4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Console\Descriptor;
14 use Symfony\Component\Console\Application;
15 use Symfony\Component\Console\Command\Command;
16 use Symfony\Component\Console\Input\InputArgument;
17 use Symfony\Component\Console\Input\InputDefinition;
18 use Symfony\Component\Console\Input\InputOption;
23 * @author Jean-François Simon <contact@jfsimon.fr>
27 class JsonDescriptor extends Descriptor
32 protected function describeInputArgument(InputArgument $argument, array $options = array())
34 $this->writeData($this->getInputArgumentData($argument), $options);
40 protected function describeInputOption(InputOption $option, array $options = array())
42 $this->writeData($this->getInputOptionData($option), $options);
48 protected function describeInputDefinition(InputDefinition $definition, array $options = array())
50 $this->writeData($this->getInputDefinitionData($definition), $options);
56 protected function describeCommand(Command $command, array $options = array())
58 $this->writeData($this->getCommandData($command), $options);
64 protected function describeApplication(Application $application, array $options = array())
66 $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
67 $description = new ApplicationDescription($application, $describedNamespace);
70 foreach ($description->getCommands() as $command) {
71 $commands[] = $this->getCommandData($command);
74 $data = $describedNamespace
75 ? array('commands' => $commands, 'namespace' => $describedNamespace)
76 : array('commands' => $commands, 'namespaces' => array_values($description->getNamespaces()));
78 $this->writeData($data, $options);
82 * Writes data as json.
85 * @param array $options
87 * @return array|string
89 private function writeData(array $data, array $options)
91 $this->write(json_encode($data, isset($options['json_encoding']) ? $options['json_encoding'] : 0));
95 * @param InputArgument $argument
99 private function getInputArgumentData(InputArgument $argument)
102 'name' => $argument->getName(),
103 'is_required' => $argument->isRequired(),
104 'is_array' => $argument->isArray(),
105 'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $argument->getDescription()),
106 'default' => INF === $argument->getDefault() ? 'INF' : $argument->getDefault(),
111 * @param InputOption $option
115 private function getInputOptionData(InputOption $option)
118 'name' => '--'.$option->getName(),
119 'shortcut' => $option->getShortcut() ? '-'.implode('|-', explode('|', $option->getShortcut())) : '',
120 'accept_value' => $option->acceptValue(),
121 'is_value_required' => $option->isValueRequired(),
122 'is_multiple' => $option->isArray(),
123 'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $option->getDescription()),
124 'default' => INF === $option->getDefault() ? 'INF' : $option->getDefault(),
129 * @param InputDefinition $definition
133 private function getInputDefinitionData(InputDefinition $definition)
135 $inputArguments = array();
136 foreach ($definition->getArguments() as $name => $argument) {
137 $inputArguments[$name] = $this->getInputArgumentData($argument);
140 $inputOptions = array();
141 foreach ($definition->getOptions() as $name => $option) {
142 $inputOptions[$name] = $this->getInputOptionData($option);
145 return array('arguments' => $inputArguments, 'options' => $inputOptions);
149 * @param Command $command
153 private function getCommandData(Command $command)
155 $command->getSynopsis();
156 $command->mergeApplicationDefinition(false);
159 'name' => $command->getName(),
160 'usage' => array_merge(array($command->getSynopsis()), $command->getUsages(), $command->getAliases()),
161 'description' => $command->getDescription(),
162 'help' => $command->getProcessedHelp(),
163 'definition' => $this->getInputDefinitionData($command->getNativeDefinition()),