[Console] simplified descriptors

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit 9c7b3586b5f57aad264e27ac94dae25af07698ce
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -11,7 +11,8 @@
 
 namespace Symfony\Component\Console;
 
-use Symfony\Component\Console\Descriptor\DescriptorProvider;
+use Symfony\Component\Console\Descriptor\TextDescriptor;
+use Symfony\Component\Console\Descriptor\XmlDescriptor;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Input\ArrayInput;
@@ -693,9 +694,9 @@ public static function getAbbreviations($names)
      */
     public function asText($namespace = null, $raw = false)
     {
-        $descriptor = new DescriptorProvider(array('namespace' => $namespace, 'raw_text' => $raw));
+        $descriptor = new TextDescriptor();
 
-        return $descriptor->get($this, 'txt')->describe($this);
+        return $descriptor->describeApplication($this, array('namespace' => $namespace, 'raw_text' => $raw));
     }
 
     /**
@@ -710,17 +711,9 @@ public function asText($namespace = null, $raw = false)
      */
     public function asXml($namespace = null, $asDom = false)
     {
-        $provider = new DescriptorProvider(array('namespace' => $namespace));
-        $descriptor = $provider->get($this, 'xml');
+        $descriptor = new XmlDescriptor();
 
-        if ($asDom) {
-            $dom = new \DOMDocument('1.0', 'UTF-8');
-            $descriptor->buildDocument($dom, $this);
-
-            return $dom;
-        }
-
-        return $descriptor->describe($this);
+        return $descriptor->describeApplication($this, array('namespace' => $namespace, 'as_dom' => $asDom));
     }
 
     /**

diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -11,7 +11,8 @@
 
 namespace Symfony\Component\Console\Command;
 
-use Symfony\Component\Console\Descriptor\DescriptorProvider;
+use Symfony\Component\Console\Descriptor\TextDescriptor;
+use Symfony\Component\Console\Descriptor\XmlDescriptor;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
@@ -565,9 +566,9 @@ public function getHelper($name)
      */
     public function asText()
     {
-        $descriptor = new DescriptorProvider();
+        $descriptor = new TextDescriptor();
 
-        return $descriptor->get($this, 'txt')->describe($this);
+        return $descriptor->describeCommand($this);
     }
 
     /**
@@ -581,17 +582,9 @@ public function asText()
      */
     public function asXml($asDom = false)
     {
-        $provider = new DescriptorProvider();
-        $descriptor = $provider->get($this, 'xml');
+        $descriptor = new XmlDescriptor();
 
-        if ($asDom) {
-            $dom = new \DOMDocument('1.0', 'UTF-8');
-            $descriptor->buildDocument($dom, $this);
-
-            return $dom;
-        }
-
-        return $descriptor->describe($this);
+        return $descriptor->describeCommand($this, array('as_dom' => $asDom));
     }
 
     private function validateName($name)

diff --git a/src/Symfony/Component/Console/Descriptor/AbstractDescriptor.php b/src/Symfony/Component/Console/Descriptor/AbstractDescriptor.php
diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php b/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php
@@ -1,64 +1,62 @@
 <?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;
+
 /**
- * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
+ * Descriptor interface.
+ *
+ * @author Jean-François Simon <contact@jfsimon.fr>
  */
 interface DescriptorInterface
 {
     /**
-     * Configures descriptor with description options.
+     * @param InputArgument $argument
      *
-     * @param array $options Description options
+     * @param array $options
      *
-     * @return DescriptorInterface
+     * @return string|mixed
      */
-    public function configure(array $options);
+    public function describeInputArgument(InputArgument $argument, array $options = array());
 
     /**
-     * Returns given object's representation.
+     * @param InputOption $option
      *
-     * @param object  $object The object to describe
+     * @param array $options
      *
-     * @return string The object formatted description
+     * @return string|mixed
      */
-    public function describe($object);
+    public function describeInputOption(InputOption $option, array $options = array());
 
     /**
-     * Tests if this descriptor supports given object.
+     * @param InputDefinition $definition
      *
-     * @param object $object The object to describe
+     * @param array $options
      *
-     * @return boolean
+     * @return string|mixed
      */
-    public function supports($object);
+    public function describeInputDefinition(InputDefinition $definition, array $options = array());
 
     /**
-     * Returns descriptor's format name.
+     * @param Command $command
      *
-     * @return string The format name
-     */
-    public function getFormat();
-
-    /**
-     * Returns true if output formatting is used.
+     * @param array $options
      *
-     * @return boolean
+     * @return string|mixed
      */
-    public function useFormatting();
+    public function describeCommand(Command $command, array $options = array());
 
     /**
-     * @param DescriptorProvider $descriptorProvider
+     * @param Application $application
+     *
+     * @param array $options
+     *
+     * @return string|mixed
      */
-    public function setDescriptorProvider(DescriptorProvider $descriptorProvider);
+    public function describeApplication(Application $application, array $options = array());
 }
diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php b/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php