class XmlDescriptor in Zircon Profile 8

XML descriptor.

@author Jean-François Simon <[e-mail]>

@internal

Hierarchy

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

5 files declare their use of XmlDescriptor

Application.php in vendor/symfony/console/Application.php

Command.php in vendor/symfony/console/Command/Command.php

DescriptorHelper.php in vendor/symfony/console/Helper/DescriptorHelper.php

InputDefinition.php in vendor/symfony/console/Input/InputDefinition.php

XmlDescriptorTest.php in vendor/symfony/console/Tests/Descriptor/XmlDescriptorTest.php

File

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

Namespace

Symfony\Component\Console\Descriptor

class XmlDescriptor extends Descriptor {

  /**
   * @param InputDefinition $definition
   *
   * @return \DOMDocument
   */
  public function getInputDefinitionDocument(InputDefinition $definition) {
    $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;
  }

  /**
   * @param Command $command
   *
   * @return \DOMDocument
   */
  public function getCommandDocument(Command $command) {
    $dom = new \DOMDocument('1.0', 'UTF-8');
    $dom
      ->appendChild($commandXML = $dom
      ->createElement('command'));
    $command
      ->getSynopsis();
    $command
      ->mergeApplicationDefinition(false);
    $commandXML
      ->setAttribute('id', $command
      ->getName());
    $commandXML
      ->setAttribute('name', $command
      ->getName());
    $commandXML
      ->appendChild($usagesXML = $dom
      ->createElement('usages'));
    foreach (array_merge(array(
      $command
        ->getSynopsis(),
    ), $command
      ->getAliases(), $command
      ->getUsages()) as $usage) {
      $usagesXML
        ->appendChild($dom
        ->createElement('usage', $usage));
    }
    $commandXML
      ->appendChild($descriptionXML = $dom
      ->createElement('description'));
    $descriptionXML
      ->appendChild($dom
      ->createTextNode(str_replace("\n", "\n ", $command
      ->getDescription())));
    $commandXML
      ->appendChild($helpXML = $dom
      ->createElement('help'));
    $helpXML
      ->appendChild($dom
      ->createTextNode(str_replace("\n", "\n ", $command
      ->getProcessedHelp())));
    $definitionXML = $this
      ->getInputDefinitionDocument($command
      ->getNativeDefinition());
    $this
      ->appendDocument($commandXML, $definitionXML
      ->getElementsByTagName('definition')
      ->item(0));
    return $dom;
  }

  /**
   * @param Application $application
   * @param string|null $namespace
   *
   * @return \DOMDocument
   */
  public function getApplicationDocument(Application $application, $namespace = null) {
    $dom = new \DOMDocument('1.0', 'UTF-8');
    $dom
      ->appendChild($rootXml = $dom
      ->createElement('symfony'));
    if ($application
      ->getName() !== 'UNKNOWN') {
      $rootXml
        ->setAttribute('name', $application
        ->getName());
      if ($application
        ->getVersion() !== 'UNKNOWN') {
        $rootXml
          ->setAttribute('version', $application
          ->getVersion());
      }
    }
    $rootXml
      ->appendChild($commandsXML = $dom
      ->createElement('commands'));
    $description = new ApplicationDescription($application, $namespace);
    if ($namespace) {
      $commandsXML
        ->setAttribute('namespace', $namespace);
    }
    foreach ($description
      ->getCommands() as $command) {
      $this
        ->appendDocument($commandsXML, $this
        ->getCommandDocument($command));
    }
    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;
  }

  /**
   * {@inheritdoc}
   */
  protected function describeInputArgument(InputArgument $argument, array $options = array()) {
    $this
      ->writeDocument($this
      ->getInputArgumentDocument($argument));
  }

  /**
   * {@inheritdoc}
   */
  protected function describeInputOption(InputOption $option, array $options = array()) {
    $this
      ->writeDocument($this
      ->getInputOptionDocument($option));
  }

  /**
   * {@inheritdoc}
   */
  protected function describeInputDefinition(InputDefinition $definition, array $options = array()) {
    $this
      ->writeDocument($this
      ->getInputDefinitionDocument($definition));
  }

  /**
   * {@inheritdoc}
   */
  protected function describeCommand(Command $command, array $options = array()) {
    $this
      ->writeDocument($this
      ->getCommandDocument($command));
  }

  /**
   * {@inheritdoc}
   */
  protected function describeApplication(Application $application, array $options = array()) {
    $this
      ->writeDocument($this
      ->getApplicationDocument($application, isset($options['namespace']) ? $options['namespace'] : null));
  }

  /**
   * Appends document children to parent node.
   *
   * @param \DOMNode $parentNode
   * @param \DOMNode $importedParent
   */
  private function appendDocument(\DOMNode $parentNode, \DOMNode $importedParent) {
    foreach ($importedParent->childNodes as $childNode) {
      $parentNode
        ->appendChild($parentNode->ownerDocument
        ->importNode($childNode, true));
    }
  }

  /**
   * Writes DOM document.
   *
   * @param \DOMDocument $dom
   *
   * @return \DOMDocument|string
   */
  private function writeDocument(\DOMDocument $dom) {
    $dom->formatOutput = true;
    $this
      ->write($dom
      ->saveXML());
  }

  /**
   * @param InputArgument $argument
   *
   * @return \DOMDocument
   */
  private function getInputArgumentDocument(InputArgument $argument) {
    $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()) ? array(
      var_export($argument
        ->getDefault(), true),
    ) : ($argument
      ->getDefault() ? array(
      $argument
        ->getDefault(),
    ) : array()));
    foreach ($defaults as $default) {
      $defaultsXML
        ->appendChild($defaultXML = $dom
        ->createElement('default'));
      $defaultXML
        ->appendChild($dom
        ->createTextNode($default));
    }
    return $dom;
  }

  /**
   * @param InputOption $option
   *
   * @return \DOMDocument
   */
  private function getInputOptionDocument(InputOption $option) {
    $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', '-' . implode('|-', explode('|', $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()) ? array(
        var_export($option
          ->getDefault(), true),
      ) : ($option
        ->getDefault() ? array(
        $option
          ->getDefault(),
      ) : array()));
      $objectXML
        ->appendChild($defaultsXML = $dom
        ->createElement('defaults'));
      if (!empty($defaults)) {
        foreach ($defaults as $default) {
          $defaultsXML
            ->appendChild($defaultXML = $dom
            ->createElement('default'));
          $defaultXML
            ->appendChild($dom
            ->createTextNode($default));
        }
      }
    }
    return $dom;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Descriptor::$output	private	property
Descriptor::describe	public	function	Describes an InputArgument instance. Overrides DescriptorInterface::describe
Descriptor::write	protected	function	Writes content to output.
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.