You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
168 lines
5.0 KiB
168 lines
5.0 KiB
<?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 = isset($options['namespace']) ? $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. |
|
* |
|
* @return array|string |
|
*/ |
|
private function writeData(array $data, array $options) |
|
{ |
|
$this->write(json_encode($data, isset($options['json_encoding']) ? $options['json_encoding'] : 0)); |
|
} |
|
|
|
/** |
|
* @return array |
|
*/ |
|
private function getInputArgumentData(InputArgument $argument) |
|
{ |
|
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(), |
|
]; |
|
} |
|
|
|
/** |
|
* @return array |
|
*/ |
|
private function getInputOptionData(InputOption $option) |
|
{ |
|
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(), |
|
]; |
|
} |
|
|
|
/** |
|
* @return array |
|
*/ |
|
private function getInputDefinitionData(InputDefinition $definition) |
|
{ |
|
$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]; |
|
} |
|
|
|
/** |
|
* @return array |
|
*/ |
|
private function getCommandData(Command $command) |
|
{ |
|
$command->getSynopsis(); |
|
$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->getNativeDefinition()), |
|
'hidden' => $command->isHidden(), |
|
]; |
|
} |
|
}
|
|
|