[Console] started text derciptors

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit 47fa194a7c927023ee0317c6c9583cbf1ddb21a9
diff --git a/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php b/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php
@@ -21,17 +21,41 @@ class ApplicationDescription
 {
     const GLOBAL_NAMESPACE = '_global';
 
+    /**
+     * @var Application
+     */
     private $application;
+
+    /**
+     * @var null|string
+     */
     private $namespace;
+
+    /**
+     * @var array
+     */
     private $namespaces;
+
+    /**
+     * @var Command[]
+     */
     private $commands;
 
+    /**
+     * Constructor.
+     *
+     * @param Application $application
+     * @param string|null $namespace
+     */
     public function __construct(Application $application, $namespace = null)
     {
         $this->application = $application;
         $this->namespace = $namespace;
     }
 
+    /**
+     * @return array
+     */
     public function getNamespaces()
     {
         if (null === $this->namespaces) {
@@ -41,6 +65,9 @@ public function getNamespaces()
         return $this->namespaces;
     }
 
+    /**
+     * @return Command[]
+     */
     public function getCommands()
     {
         if (null === $this->commands) {
@@ -50,6 +77,22 @@ public function getCommands()
         return $this->commands;
     }
 
+    /**
+     * @param string $name
+     *
+     * @return Command
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function getCommand($name)
+    {
+        if (!isset($this->commands[$name])) {
+            throw new \InvalidArgumentException('Command "'.$name.'" does not exist.');
+        }
+
+        return $this->commands[$name];
+    }
+
     private function inspectApplication()
     {
         $this->commands = array();
@@ -67,16 +110,21 @@ private function inspectApplication()
 
                 // aliases must be skipped in commands list
                 if ($name === $command->getName()) {
-                    $this->commands[] = $command;
+                    $this->commands[$name] = $command;
                 }
 
                 $names[] = $name;
             }
 
-            $this->namespaces[] = array('id' => $namespace, 'commands' => $names);
+            $this->namespaces[$namespace] = array('id' => $namespace, 'commands' => $names);
         }
     }
 
+    /**
+     * @param array $commands
+     *
+     * @return array
+     */
     private function sortCommands(array $commands)
     {
         $method = new \ReflectionMethod($this->application, 'sortCommands');

diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php b/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php
@@ -29,11 +29,10 @@ public function configure(array $options);
      * Returns given object's representation.
      *
      * @param object  $object The object to describe
-     * @param boolean $raw    No additional markers if true
      *
      * @return string The object formatted description
      */
-    public function describe($object, $raw = false);
+    public function describe($object);
 
     /**
      * Tests if this descriptor supports given object.

diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php b/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php
@@ -29,6 +29,7 @@ class DescriptorProvider
     private $options = array(
         'default_format' => 'txt',
         'namespace'      => null,
+        'raw_text'       => false,
         'json_encoding'  => 0,
         'markdown_width' => 120,
     );
@@ -42,6 +43,11 @@ public function __construct(array $options = array())
     {
         $this
             ->configure($options)
+            ->add(new Xml\ApplicationXmlDescriptor())
+            ->add(new Xml\CommandXmlDescriptor())
+            ->add(new Xml\InputDefinitionXmlDescriptor())
+            ->add(new Xml\InputArgumentXmlDescriptor())
+            ->add(new Xml\InputOptionXmlDescriptor())
             ->add(new Json\ApplicationJsonDescriptor())
             ->add(new Json\CommandJsonDescriptor())
             ->add(new Json\InputDefinitionJsonDescriptor())

diff --git a/src/Symfony/Component/Console/Descriptor/Json/AbstractJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/AbstractJsonDescriptor.php
@@ -46,7 +46,7 @@ public function configure(array $options)
     /**
      * {@inheritdoc}
      */
-    public function describe($object, $raw = false)
+    public function describe($object)
     {
         return json_encode($this->getData($object), $this->encodingOptions);
     }
@@ -75,18 +75,4 @@ public function useFormatting()
     {
         return false;
     }
-
-    /**
-     * Builds a JSON descriptor.
-     *
-     * @param AbstractJsonDescriptor $descriptor
-     *
-     * @return AbstractJsonDescriptor
-     */
-    protected function build(AbstractJsonDescriptor $descriptor)
-    {
-        $descriptor->configure(array('json_encoding' => $this->encodingOptions));
-
-        return $descriptor;
-    }
 }
diff --git a/src/Symfony/Component/Console/Descriptor/Json/ApplicationJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/ApplicationJsonDescriptor.php
@@ -53,7 +53,7 @@ public function getData($object)
     {
         /** @var Application $object */
         $description = new ApplicationDescription($object, $this->namespace);
-        $descriptor = $this->build(new CommandJsonDescriptor());
+        $descriptor = new CommandJsonDescriptor();
         $commands = array_map(array($descriptor, 'getData'), $description->getCommands());
 
         return null === $this->namespace

diff --git a/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php
@@ -23,7 +23,7 @@ class CommandJsonDescriptor extends AbstractJsonDescriptor
      */
     public function getData($object)
     {
-        $definitionDescriptor = $this->build(new InputDefinitionJsonDescriptor());
+        $definitionDescriptor = new InputDefinitionJsonDescriptor();
 
         /** @var Command $object */
         return array(

diff --git a/src/Symfony/Component/Console/Descriptor/Json/InputDefinitionJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/InputDefinitionJsonDescriptor.php
@@ -25,8 +25,8 @@ class InputDefinitionJsonDescriptor extends AbstractJsonDescriptor
      */
     public function getData($object)
     {
-        $argumentDescriptor = $this->build(new InputArgumentJsonDescriptor());
-        $optionDescriptor = $this->build(new InputOptionJsonDescriptor());
+        $argumentDescriptor = new InputArgumentJsonDescriptor();
+        $optionDescriptor = new InputOptionJsonDescriptor();
 
         /** @var InputDefinition $object */
         return array(

diff --git a/src/Symfony/Component/Console/Descriptor/Markdown/AbstractMarkdownDescriptor.php b/src/Symfony/Component/Console/Descriptor/Markdown/AbstractMarkdownDescriptor.php
@@ -46,7 +46,7 @@ public function configure(array $options)
     /**
      * {@inheritdoc}
      */
-    public function describe($object, $raw = false)
+    public function describe($object)
     {
         return $this->getDocument($object)->format(new Document\Formatter($this->maxWidth));
     }

diff --git a/src/Symfony/Component/Console/Descriptor/Text/AbstractTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/AbstractTextDescriptor.php
@@ -0,0 +1,87 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Descriptor\Text;
+
+use Symfony\Component\Console\Descriptor\DescriptorInterface;
+
+/**
+ * @author Jean-François Simon <[email protected]>
+ */
+abstract class AbstractTextDescriptor implements DescriptorInterface
+{
+    /**
+     * @var boolean
+     */
+    private $raw;
+
+    /**
+     * @param boolean $raw
+     */
+    public function __construct($raw = false)
+    {
+        $this->raw = $raw;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configure(array $options)
+    {
+        if (isset($options['raw_text'])) {
+            $this->raw = $options['raw_text'];
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function describe($object)
+    {
+        return $this->raw ? $this->getRawText($object) : $this->getFormattedText($object);
+    }
+
+    /**
+     * Returns object's raw text description.
+     *
+     * @param object $object
+     *
+     * @return string
+     */
+    abstract public function getRawText($object);
+
+    /**
+     * Returns object's formatted text description.
+     *
+     * @param object $object
+     *
+     * @return string
+     */
+    abstract public function getFormattedText($object);
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormat()
+    {
+        return 'txt';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function useFormatting()
+    {
+        return false;
+    }
+}