Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Console\Descriptor;
Chris@0: 
Chris@0: use Symfony\Component\Console\Application;
Chris@0: use Symfony\Component\Console\Command\Command;
Chris@0: use Symfony\Component\Console\Input\InputArgument;
Chris@0: use Symfony\Component\Console\Input\InputDefinition;
Chris@0: use Symfony\Component\Console\Input\InputOption;
Chris@0: 
Chris@0: /**
Chris@0:  * JSON descriptor.
Chris@0:  *
Chris@0:  * @author Jean-François Simon <contact@jfsimon.fr>
Chris@0:  *
Chris@0:  * @internal
Chris@0:  */
Chris@0: class JsonDescriptor extends Descriptor
Chris@0: {
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     protected function describeInputArgument(InputArgument $argument, array $options = [])
Chris@0:     {
Chris@0:         $this->writeData($this->getInputArgumentData($argument), $options);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     protected function describeInputOption(InputOption $option, array $options = [])
Chris@0:     {
Chris@0:         $this->writeData($this->getInputOptionData($option), $options);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     protected function describeInputDefinition(InputDefinition $definition, array $options = [])
Chris@0:     {
Chris@0:         $this->writeData($this->getInputDefinitionData($definition), $options);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     protected function describeCommand(Command $command, array $options = [])
Chris@0:     {
Chris@0:         $this->writeData($this->getCommandData($command), $options);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     protected function describeApplication(Application $application, array $options = [])
Chris@0:     {
Chris@0:         $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
Chris@14:         $description = new ApplicationDescription($application, $describedNamespace, true);
Chris@17:         $commands = [];
Chris@0: 
Chris@0:         foreach ($description->getCommands() as $command) {
Chris@0:             $commands[] = $this->getCommandData($command);
Chris@0:         }
Chris@0: 
Chris@17:         $data = [];
Chris@14:         if ('UNKNOWN' !== $application->getName()) {
Chris@14:             $data['application']['name'] = $application->getName();
Chris@14:             if ('UNKNOWN' !== $application->getVersion()) {
Chris@14:                 $data['application']['version'] = $application->getVersion();
Chris@14:             }
Chris@14:         }
Chris@14: 
Chris@14:         $data['commands'] = $commands;
Chris@14: 
Chris@14:         if ($describedNamespace) {
Chris@14:             $data['namespace'] = $describedNamespace;
Chris@14:         } else {
Chris@14:             $data['namespaces'] = array_values($description->getNamespaces());
Chris@14:         }
Chris@0: 
Chris@0:         $this->writeData($data, $options);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Writes data as json.
Chris@0:      *
Chris@0:      * @return array|string
Chris@0:      */
Chris@0:     private function writeData(array $data, array $options)
Chris@0:     {
Chris@0:         $this->write(json_encode($data, isset($options['json_encoding']) ? $options['json_encoding'] : 0));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return array
Chris@0:      */
Chris@0:     private function getInputArgumentData(InputArgument $argument)
Chris@0:     {
Chris@17:         return [
Chris@0:             'name' => $argument->getName(),
Chris@0:             'is_required' => $argument->isRequired(),
Chris@0:             'is_array' => $argument->isArray(),
Chris@0:             'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $argument->getDescription()),
Chris@12:             'default' => INF === $argument->getDefault() ? 'INF' : $argument->getDefault(),
Chris@17:         ];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return array
Chris@0:      */
Chris@0:     private function getInputOptionData(InputOption $option)
Chris@0:     {
Chris@17:         return [
Chris@0:             'name' => '--'.$option->getName(),
Chris@16:             'shortcut' => $option->getShortcut() ? '-'.str_replace('|', '|-', $option->getShortcut()) : '',
Chris@0:             'accept_value' => $option->acceptValue(),
Chris@0:             'is_value_required' => $option->isValueRequired(),
Chris@0:             'is_multiple' => $option->isArray(),
Chris@0:             'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $option->getDescription()),
Chris@12:             'default' => INF === $option->getDefault() ? 'INF' : $option->getDefault(),
Chris@17:         ];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return array
Chris@0:      */
Chris@0:     private function getInputDefinitionData(InputDefinition $definition)
Chris@0:     {
Chris@17:         $inputArguments = [];
Chris@0:         foreach ($definition->getArguments() as $name => $argument) {
Chris@0:             $inputArguments[$name] = $this->getInputArgumentData($argument);
Chris@0:         }
Chris@0: 
Chris@17:         $inputOptions = [];
Chris@0:         foreach ($definition->getOptions() as $name => $option) {
Chris@0:             $inputOptions[$name] = $this->getInputOptionData($option);
Chris@0:         }
Chris@0: 
Chris@17:         return ['arguments' => $inputArguments, 'options' => $inputOptions];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return array
Chris@0:      */
Chris@0:     private function getCommandData(Command $command)
Chris@0:     {
Chris@0:         $command->getSynopsis();
Chris@0:         $command->mergeApplicationDefinition(false);
Chris@0: 
Chris@17:         return [
Chris@0:             'name' => $command->getName(),
Chris@17:             'usage' => array_merge([$command->getSynopsis()], $command->getUsages(), $command->getAliases()),
Chris@0:             'description' => $command->getDescription(),
Chris@0:             'help' => $command->getProcessedHelp(),
Chris@0:             'definition' => $this->getInputDefinitionData($command->getNativeDefinition()),
Chris@14:             'hidden' => $command->isHidden(),
Chris@17:         ];
Chris@0:     }
Chris@0: }