Chris@0: 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: * XML descriptor. Chris@0: * Chris@0: * @author Jean-François Simon Chris@0: * Chris@0: * @internal Chris@0: */ Chris@0: class XmlDescriptor extends Descriptor Chris@0: { Chris@0: /** Chris@0: * @return \DOMDocument Chris@0: */ Chris@0: public function getInputDefinitionDocument(InputDefinition $definition) Chris@0: { Chris@0: $dom = new \DOMDocument('1.0', 'UTF-8'); Chris@0: $dom->appendChild($definitionXML = $dom->createElement('definition')); Chris@0: Chris@0: $definitionXML->appendChild($argumentsXML = $dom->createElement('arguments')); Chris@0: foreach ($definition->getArguments() as $argument) { Chris@0: $this->appendDocument($argumentsXML, $this->getInputArgumentDocument($argument)); Chris@0: } Chris@0: Chris@0: $definitionXML->appendChild($optionsXML = $dom->createElement('options')); Chris@0: foreach ($definition->getOptions() as $option) { Chris@0: $this->appendDocument($optionsXML, $this->getInputOptionDocument($option)); Chris@0: } Chris@0: Chris@0: return $dom; Chris@0: } Chris@0: Chris@0: /** Chris@0: * @return \DOMDocument Chris@0: */ Chris@0: public function getCommandDocument(Command $command) Chris@0: { Chris@0: $dom = new \DOMDocument('1.0', 'UTF-8'); Chris@0: $dom->appendChild($commandXML = $dom->createElement('command')); Chris@0: Chris@0: $command->getSynopsis(); Chris@0: $command->mergeApplicationDefinition(false); Chris@0: Chris@0: $commandXML->setAttribute('id', $command->getName()); Chris@0: $commandXML->setAttribute('name', $command->getName()); Chris@14: $commandXML->setAttribute('hidden', $command->isHidden() ? 1 : 0); Chris@0: Chris@0: $commandXML->appendChild($usagesXML = $dom->createElement('usages')); Chris@0: Chris@17: foreach (array_merge([$command->getSynopsis()], $command->getAliases(), $command->getUsages()) as $usage) { Chris@0: $usagesXML->appendChild($dom->createElement('usage', $usage)); Chris@0: } Chris@0: Chris@0: $commandXML->appendChild($descriptionXML = $dom->createElement('description')); Chris@0: $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $command->getDescription()))); Chris@0: Chris@0: $commandXML->appendChild($helpXML = $dom->createElement('help')); Chris@0: $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $command->getProcessedHelp()))); Chris@0: Chris@0: $definitionXML = $this->getInputDefinitionDocument($command->getNativeDefinition()); Chris@0: $this->appendDocument($commandXML, $definitionXML->getElementsByTagName('definition')->item(0)); Chris@0: Chris@0: return $dom; Chris@0: } Chris@0: Chris@0: /** Chris@0: * @param Application $application Chris@0: * @param string|null $namespace Chris@0: * Chris@0: * @return \DOMDocument Chris@0: */ Chris@0: public function getApplicationDocument(Application $application, $namespace = null) Chris@0: { Chris@0: $dom = new \DOMDocument('1.0', 'UTF-8'); Chris@0: $dom->appendChild($rootXml = $dom->createElement('symfony')); Chris@0: Chris@14: if ('UNKNOWN' !== $application->getName()) { Chris@0: $rootXml->setAttribute('name', $application->getName()); Chris@14: if ('UNKNOWN' !== $application->getVersion()) { Chris@0: $rootXml->setAttribute('version', $application->getVersion()); Chris@0: } Chris@0: } Chris@0: Chris@0: $rootXml->appendChild($commandsXML = $dom->createElement('commands')); Chris@0: Chris@14: $description = new ApplicationDescription($application, $namespace, true); Chris@0: Chris@0: if ($namespace) { Chris@0: $commandsXML->setAttribute('namespace', $namespace); Chris@0: } Chris@0: Chris@0: foreach ($description->getCommands() as $command) { Chris@0: $this->appendDocument($commandsXML, $this->getCommandDocument($command)); Chris@0: } Chris@0: Chris@0: if (!$namespace) { Chris@0: $rootXml->appendChild($namespacesXML = $dom->createElement('namespaces')); Chris@0: Chris@0: foreach ($description->getNamespaces() as $namespaceDescription) { Chris@0: $namespacesXML->appendChild($namespaceArrayXML = $dom->createElement('namespace')); Chris@0: $namespaceArrayXML->setAttribute('id', $namespaceDescription['id']); Chris@0: Chris@0: foreach ($namespaceDescription['commands'] as $name) { Chris@0: $namespaceArrayXML->appendChild($commandXML = $dom->createElement('command')); Chris@0: $commandXML->appendChild($dom->createTextNode($name)); Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: return $dom; Chris@0: } Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@17: protected function describeInputArgument(InputArgument $argument, array $options = []) Chris@0: { Chris@0: $this->writeDocument($this->getInputArgumentDocument($argument)); 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->writeDocument($this->getInputOptionDocument($option)); 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->writeDocument($this->getInputDefinitionDocument($definition)); 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->writeDocument($this->getCommandDocument($command)); Chris@0: } Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@17: protected function describeApplication(Application $application, array $options = []) Chris@0: { Chris@0: $this->writeDocument($this->getApplicationDocument($application, isset($options['namespace']) ? $options['namespace'] : null)); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Appends document children to parent node. Chris@0: */ Chris@0: private function appendDocument(\DOMNode $parentNode, \DOMNode $importedParent) Chris@0: { Chris@0: foreach ($importedParent->childNodes as $childNode) { Chris@0: $parentNode->appendChild($parentNode->ownerDocument->importNode($childNode, true)); Chris@0: } Chris@0: } Chris@0: Chris@0: /** Chris@0: * Writes DOM document. Chris@0: * Chris@0: * @return \DOMDocument|string Chris@0: */ Chris@0: private function writeDocument(\DOMDocument $dom) Chris@0: { Chris@0: $dom->formatOutput = true; Chris@0: $this->write($dom->saveXML()); Chris@0: } Chris@0: Chris@0: /** Chris@0: * @return \DOMDocument Chris@0: */ Chris@0: private function getInputArgumentDocument(InputArgument $argument) Chris@0: { Chris@0: $dom = new \DOMDocument('1.0', 'UTF-8'); Chris@0: Chris@0: $dom->appendChild($objectXML = $dom->createElement('argument')); Chris@0: $objectXML->setAttribute('name', $argument->getName()); Chris@0: $objectXML->setAttribute('is_required', $argument->isRequired() ? 1 : 0); Chris@0: $objectXML->setAttribute('is_array', $argument->isArray() ? 1 : 0); Chris@0: $objectXML->appendChild($descriptionXML = $dom->createElement('description')); Chris@0: $descriptionXML->appendChild($dom->createTextNode($argument->getDescription())); Chris@0: Chris@0: $objectXML->appendChild($defaultsXML = $dom->createElement('defaults')); Chris@17: $defaults = \is_array($argument->getDefault()) ? $argument->getDefault() : (\is_bool($argument->getDefault()) ? [var_export($argument->getDefault(), true)] : ($argument->getDefault() ? [$argument->getDefault()] : [])); Chris@0: foreach ($defaults as $default) { Chris@0: $defaultsXML->appendChild($defaultXML = $dom->createElement('default')); Chris@0: $defaultXML->appendChild($dom->createTextNode($default)); Chris@0: } Chris@0: Chris@0: return $dom; Chris@0: } Chris@0: Chris@0: /** Chris@0: * @return \DOMDocument Chris@0: */ Chris@0: private function getInputOptionDocument(InputOption $option) Chris@0: { Chris@0: $dom = new \DOMDocument('1.0', 'UTF-8'); Chris@0: Chris@0: $dom->appendChild($objectXML = $dom->createElement('option')); Chris@0: $objectXML->setAttribute('name', '--'.$option->getName()); Chris@0: $pos = strpos($option->getShortcut(), '|'); Chris@0: if (false !== $pos) { Chris@0: $objectXML->setAttribute('shortcut', '-'.substr($option->getShortcut(), 0, $pos)); Chris@16: $objectXML->setAttribute('shortcuts', '-'.str_replace('|', '|-', $option->getShortcut())); Chris@0: } else { Chris@0: $objectXML->setAttribute('shortcut', $option->getShortcut() ? '-'.$option->getShortcut() : ''); Chris@0: } Chris@0: $objectXML->setAttribute('accept_value', $option->acceptValue() ? 1 : 0); Chris@0: $objectXML->setAttribute('is_value_required', $option->isValueRequired() ? 1 : 0); Chris@0: $objectXML->setAttribute('is_multiple', $option->isArray() ? 1 : 0); Chris@0: $objectXML->appendChild($descriptionXML = $dom->createElement('description')); Chris@0: $descriptionXML->appendChild($dom->createTextNode($option->getDescription())); Chris@0: Chris@0: if ($option->acceptValue()) { Chris@17: $defaults = \is_array($option->getDefault()) ? $option->getDefault() : (\is_bool($option->getDefault()) ? [var_export($option->getDefault(), true)] : ($option->getDefault() ? [$option->getDefault()] : [])); Chris@0: $objectXML->appendChild($defaultsXML = $dom->createElement('defaults')); Chris@0: Chris@0: if (!empty($defaults)) { Chris@0: foreach ($defaults as $default) { Chris@0: $defaultsXML->appendChild($defaultXML = $dom->createElement('default')); Chris@0: $defaultXML->appendChild($dom->createTextNode($default)); Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: return $dom; Chris@0: } Chris@0: }