Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. XmlDescriptor.php

class XmlDescriptor

XML descriptor.

@author Jean-François Simon <contact@jfsimon.fr>

@internal

Hierarchy

  • class \Symfony\Component\Console\Descriptor\Descriptor implements \Symfony\Component\Console\Descriptor\DescriptorInterface
    • class \Symfony\Component\Console\Descriptor\XmlDescriptor extends \Symfony\Component\Console\Descriptor\Descriptor

Expanded class hierarchy of XmlDescriptor

1 file declares its use of XmlDescriptor
DescriptorHelper.php in vendor/symfony/console/Helper/DescriptorHelper.php

File

vendor/symfony/console/Descriptor/XmlDescriptor.php, line 27

Namespace

Symfony\Component\Console\Descriptor
View source
class XmlDescriptor extends Descriptor {
    public function getInputDefinitionDocument(InputDefinition $definition) : \DOMDocument {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->appendChild($definitionXML = $dom->createElement('definition'));
        $definitionXML->appendChild($argumentsXML = $dom->createElement('arguments'));
        foreach ($definition->getArguments() as $argument) {
            $this->appendDocument($argumentsXML, $this->getInputArgumentDocument($argument));
        }
        $definitionXML->appendChild($optionsXML = $dom->createElement('options'));
        foreach ($definition->getOptions() as $option) {
            $this->appendDocument($optionsXML, $this->getInputOptionDocument($option));
        }
        return $dom;
    }
    public function getCommandDocument(Command $command, bool $short = false) : \DOMDocument {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->appendChild($commandXML = $dom->createElement('command'));
        $commandXML->setAttribute('id', $command->getName());
        $commandXML->setAttribute('name', $command->getName());
        $commandXML->setAttribute('hidden', $command->isHidden() ? 1 : 0);
        $commandXML->appendChild($usagesXML = $dom->createElement('usages'));
        $commandXML->appendChild($descriptionXML = $dom->createElement('description'));
        $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $command->getDescription())));
        if ($short) {
            foreach ($command->getAliases() as $usage) {
                $usagesXML->appendChild($dom->createElement('usage', $usage));
            }
        }
        else {
            $command->mergeApplicationDefinition(false);
            foreach (array_merge([
                $command->getSynopsis(),
            ], $command->getAliases(), $command->getUsages()) as $usage) {
                $usagesXML->appendChild($dom->createElement('usage', $usage));
            }
            $commandXML->appendChild($helpXML = $dom->createElement('help'));
            $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $command->getProcessedHelp())));
            $definitionXML = $this->getInputDefinitionDocument($command->getDefinition());
            $this->appendDocument($commandXML, $definitionXML->getElementsByTagName('definition')
                ->item(0));
        }
        return $dom;
    }
    public function getApplicationDocument(Application $application, ?string $namespace = null, bool $short = false) : \DOMDocument {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->appendChild($rootXml = $dom->createElement('symfony'));
        if ('UNKNOWN' !== $application->getName()) {
            $rootXml->setAttribute('name', $application->getName());
            if ('UNKNOWN' !== $application->getVersion()) {
                $rootXml->setAttribute('version', $application->getVersion());
            }
        }
        $rootXml->appendChild($commandsXML = $dom->createElement('commands'));
        $description = new ApplicationDescription($application, $namespace, true);
        if ($namespace) {
            $commandsXML->setAttribute('namespace', $namespace);
        }
        foreach ($description->getCommands() as $command) {
            $this->appendDocument($commandsXML, $this->getCommandDocument($command, $short));
        }
        if (!$namespace) {
            $rootXml->appendChild($namespacesXML = $dom->createElement('namespaces'));
            foreach ($description->getNamespaces() as $namespaceDescription) {
                $namespacesXML->appendChild($namespaceArrayXML = $dom->createElement('namespace'));
                $namespaceArrayXML->setAttribute('id', $namespaceDescription['id']);
                foreach ($namespaceDescription['commands'] as $name) {
                    $namespaceArrayXML->appendChild($commandXML = $dom->createElement('command'));
                    $commandXML->appendChild($dom->createTextNode($name));
                }
            }
        }
        return $dom;
    }
    protected function describeInputArgument(InputArgument $argument, array $options = []) : void {
        $this->writeDocument($this->getInputArgumentDocument($argument));
    }
    protected function describeInputOption(InputOption $option, array $options = []) : void {
        $this->writeDocument($this->getInputOptionDocument($option));
    }
    protected function describeInputDefinition(InputDefinition $definition, array $options = []) : void {
        $this->writeDocument($this->getInputDefinitionDocument($definition));
    }
    protected function describeCommand(Command $command, array $options = []) : void {
        $this->writeDocument($this->getCommandDocument($command, $options['short'] ?? false));
    }
    protected function describeApplication(Application $application, array $options = []) : void {
        $this->writeDocument($this->getApplicationDocument($application, $options['namespace'] ?? null, $options['short'] ?? false));
    }
    
    /**
     * Appends document children to parent node.
     */
    private function appendDocument(\DOMNode $parentNode, \DOMNode $importedParent) : void {
        foreach ($importedParent->childNodes as $childNode) {
            $parentNode->appendChild($parentNode->ownerDocument
                ->importNode($childNode, true));
        }
    }
    
    /**
     * Writes DOM document.
     */
    private function writeDocument(\DOMDocument $dom) : void {
        $dom->formatOutput = true;
        $this->write($dom->saveXML());
    }
    private function getInputArgumentDocument(InputArgument $argument) : \DOMDocument {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->appendChild($objectXML = $dom->createElement('argument'));
        $objectXML->setAttribute('name', $argument->getName());
        $objectXML->setAttribute('is_required', $argument->isRequired() ? 1 : 0);
        $objectXML->setAttribute('is_array', $argument->isArray() ? 1 : 0);
        $objectXML->appendChild($descriptionXML = $dom->createElement('description'));
        $descriptionXML->appendChild($dom->createTextNode($argument->getDescription()));
        $objectXML->appendChild($defaultsXML = $dom->createElement('defaults'));
        $defaults = \is_array($argument->getDefault()) ? $argument->getDefault() : (\is_bool($argument->getDefault()) ? [
            var_export($argument->getDefault(), true),
        ] : ($argument->getDefault() ? [
            $argument->getDefault(),
        ] : []));
        foreach ($defaults as $default) {
            $defaultsXML->appendChild($defaultXML = $dom->createElement('default'));
            $defaultXML->appendChild($dom->createTextNode($default));
        }
        return $dom;
    }
    private function getInputOptionDocument(InputOption $option) : \DOMDocument {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->appendChild($objectXML = $dom->createElement('option'));
        $objectXML->setAttribute('name', '--' . $option->getName());
        $pos = strpos($option->getShortcut() ?? '', '|');
        if (false !== $pos) {
            $objectXML->setAttribute('shortcut', '-' . substr($option->getShortcut(), 0, $pos));
            $objectXML->setAttribute('shortcuts', '-' . str_replace('|', '|-', $option->getShortcut()));
        }
        else {
            $objectXML->setAttribute('shortcut', $option->getShortcut() ? '-' . $option->getShortcut() : '');
        }
        $objectXML->setAttribute('accept_value', $option->acceptValue() ? 1 : 0);
        $objectXML->setAttribute('is_value_required', $option->isValueRequired() ? 1 : 0);
        $objectXML->setAttribute('is_multiple', $option->isArray() ? 1 : 0);
        $objectXML->appendChild($descriptionXML = $dom->createElement('description'));
        $descriptionXML->appendChild($dom->createTextNode($option->getDescription()));
        if ($option->acceptValue()) {
            $defaults = \is_array($option->getDefault()) ? $option->getDefault() : (\is_bool($option->getDefault()) ? [
                var_export($option->getDefault(), true),
            ] : ($option->getDefault() ? [
                $option->getDefault(),
            ] : []));
            $objectXML->appendChild($defaultsXML = $dom->createElement('defaults'));
            foreach ($defaults as $default) {
                $defaultsXML->appendChild($defaultXML = $dom->createElement('default'));
                $defaultXML->appendChild($dom->createTextNode($default));
            }
        }
        if ($option->isNegatable()) {
            $dom->appendChild($objectXML = $dom->createElement('option'));
            $objectXML->setAttribute('name', '--no-' . $option->getName());
            $objectXML->setAttribute('shortcut', '');
            $objectXML->setAttribute('accept_value', 0);
            $objectXML->setAttribute('is_value_required', 0);
            $objectXML->setAttribute('is_multiple', 0);
            $objectXML->appendChild($descriptionXML = $dom->createElement('description'));
            $descriptionXML->appendChild($dom->createTextNode('Negate the "--' . $option->getName() . '" option'));
        }
        return $dom;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Descriptor::$output protected property
Descriptor::describe public function Overrides DescriptorInterface::describe 2
Descriptor::write protected function 2
XmlDescriptor::appendDocument private function Appends document children to parent node.
XmlDescriptor::describeApplication protected function Describes an Application instance. Overrides Descriptor::describeApplication
XmlDescriptor::describeCommand protected function Describes a Command instance. Overrides Descriptor::describeCommand
XmlDescriptor::describeInputArgument protected function Describes an InputArgument instance. Overrides Descriptor::describeInputArgument
XmlDescriptor::describeInputDefinition protected function Describes an InputDefinition instance. Overrides Descriptor::describeInputDefinition
XmlDescriptor::describeInputOption protected function Describes an InputOption instance. Overrides Descriptor::describeInputOption
XmlDescriptor::getApplicationDocument public function
XmlDescriptor::getCommandDocument public function
XmlDescriptor::getInputArgumentDocument private function
XmlDescriptor::getInputDefinitionDocument public function
XmlDescriptor::getInputOptionDocument private function
XmlDescriptor::writeDocument private function Writes DOM document.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal