[Console] simplified descriptor interface

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit ce60fb7c624c6fafd1017de6d56d8cca8d25cba8
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -696,7 +696,7 @@ public function asText($namespace = null, $raw = false)
     {
         $descriptor = new TextDescriptor();
 
-        return $descriptor->describeApplication($this, array('namespace' => $namespace, 'raw_text' => $raw));
+        return $descriptor->describe($this, array('namespace' => $namespace, 'raw_text' => $raw));
     }
 
     /**
@@ -713,7 +713,7 @@ public function asXml($namespace = null, $asDom = false)
     {
         $descriptor = new XmlDescriptor();
 
-        return $descriptor->describeApplication($this, array('namespace' => $namespace, 'as_dom' => $asDom));
+        return $descriptor->describe($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
@@ -568,7 +568,7 @@ public function asText()
     {
         $descriptor = new TextDescriptor();
 
        return $descriptor->describeCommand($this);
+        return $descriptor->describe($this);
     }
 
     /**
@@ -584,7 +584,7 @@ public function asXml($asDom = false)
     {
         $descriptor = new XmlDescriptor();
 
-        return $descriptor->describeCommand($this, array('as_dom' => $asDom));
+        return $descriptor->describe($this, array('as_dom' => $asDom));
     }
 
     private function validateName($name)

diff --git a/src/Symfony/Component/Console/Descriptor/Descriptor.php b/src/Symfony/Component/Console/Descriptor/Descriptor.php
@@ -0,0 +1,92 @@
+<?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>
+ */
+abstract class Descriptor implements DescriptorInterface
+{
+    public function describe($object, array $options = array())
+    {
+        switch (true) {
+            case $object instanceof InputArgument:
+                return $this->describeInputArgument($object, $options);
+            case $object instanceof InputOption:
+                return $this->describeInputOption($object, $options);
+            case $object instanceof InputDefinition:
+                return $this->describeInputDefinition($object, $options);
+            case $object instanceof Command:
+                return $this->describeCommand($object, $options);
+            case $object instanceof Application:
+                return $this->describeApplication($object, $options);
+        }
+
+        throw new \InvalidArgumentException(sprintf('Object of type "%s" is not describable.', get_class($object)));
+    }
+
+    /**
+     * Describes an InputArgument instance.
+     *
+     * @param InputArgument $argument
+     * @param array         $options
+     *
+     * @return string|mixed
+     */
+    abstract protected function describeInputArgument(InputArgument $argument, array $options = array());
+
+    /**
+     * Describes an InputOption instance.
+     *
+     * @param InputOption $option
+     * @param array       $options
+     *
+     * @return string|mixed
+     */
+    abstract protected function describeInputOption(InputOption $option, array $options = array());
+
+    /**
+     * Describes an InputDefinition instance.
+     *
+     * @param InputDefinition $definition
+     * @param array           $options
+     *
+     * @return string|mixed
+     */
+    abstract protected function describeInputDefinition(InputDefinition $definition, array $options = array());
+
+    /**
+     * Describes a Command instance.
+     *
+     * @param Command $command
+     * @param array   $options
+     *
+     * @return string|mixed
+     */
+    abstract protected function describeCommand(Command $command, array $options = array());
+
+    /**
+     * Describes an Application instance.
+     *
+     * @param Application $application
+     * @param array       $options
+     *
+     * @return string|mixed
+     */
+    abstract protected function describeApplication(Application $application, array $options = array());
+}
diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php b/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php
@@ -11,12 +11,6 @@
 
 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;
-
 /**
  * Descriptor interface.
  *
@@ -27,50 +21,10 @@ interface DescriptorInterface
     /**
      * Describes an InputArgument instance.
      *
-     * @param InputArgument $argument
-     * @param array         $options
-     *
-     * @return string|mixed
-     */
-    public function describeInputArgument(InputArgument $argument, array $options = array());
-
-    /**
-     * Describes an InputOption instance.
-     *
-     * @param InputOption $option
-     * @param array       $options
-     *
-     * @return string|mixed
-     */
-    public function describeInputOption(InputOption $option, array $options = array());
-
-    /**
-     * Describes an InputDefinition instance.
-     *
-     * @param InputDefinition $definition
-     * @param array           $options
-     *
-     * @return string|mixed
-     */
-    public function describeInputDefinition(InputDefinition $definition, array $options = array());
-
-    /**
-     * Describes a Command instance.
-     *
-     * @param Command $command
-     * @param array   $options
-     *
-     * @return string|mixed
-     */
-    public function describeCommand(Command $command, array $options = array());
-
-    /**
-     * Describes an Application instance.
-     *
-     * @param Application $application
-     * @param array       $options
+     * @param object $object
+     * @param array  $options
      *
      * @return string|mixed
      */
-    public function describeApplication(Application $application, array $options = array());
+    public function describe($object, array $options = array());
 }
diff --git a/src/Symfony/Component/Console/Descriptor/JsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/JsonDescriptor.php
@@ -22,12 +22,12 @@
  *
  * @author Jean-François Simon <contact@jfsimon.fr>
  */
-class JsonDescriptor implements DescriptorInterface
+class JsonDescriptor extends Descriptor
 {
     /**
      * {@inheritdoc}
      */
-    public function describeInputArgument(InputArgument $argument, array $options = array())
+    protected function describeInputArgument(InputArgument $argument, array $options = array())
     {
         return $this->output(array(
             'name'        => $argument->getName(),
@@ -41,7 +41,7 @@ public function describeInputArgument(InputArgument $argument, array $options =
     /**
      * {@inheritdoc}
      */
-    public function describeInputOption(InputOption $option, array $options = array())
+    protected function describeInputOption(InputOption $option, array $options = array())
     {
         return $this->output(array(
             'name'              => '--'.$option->getName(),
@@ -57,7 +57,7 @@ public function describeInputOption(InputOption $option, array $options = array(
     /**
      * {@inheritdoc}
      */
-    public function describeInputDefinition(InputDefinition $definition, array $options = array())
+    protected function describeInputDefinition(InputDefinition $definition, array $options = array())
     {
         $inputArguments = array();
         foreach ($definition->getArguments() as $name => $argument) {
@@ -75,7 +75,7 @@ public function describeInputDefinition(InputDefinition $definition, array $opti
     /**
      * {@inheritdoc}
      */
-    public function describeCommand(Command $command, array $options = array())
+    protected function describeCommand(Command $command, array $options = array())
     {
         $command->getSynopsis();
         $command->mergeApplicationDefinition(false);
@@ -93,7 +93,7 @@ public function describeCommand(Command $command, array $options = array())
     /**
      * {@inheritdoc}
      */
-    public function describeApplication(Application $application, array $options = array())
+    protected function describeApplication(Application $application, array $options = array())
     {
         $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
         $description = new ApplicationDescription($application, $describedNamespace);

diff --git a/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php
@@ -22,12 +22,12 @@
  *
  * @author Jean-François Simon <contact@jfsimon.fr>
  */
-class MarkdownDescriptor implements DescriptorInterface
+class MarkdownDescriptor extends Descriptor
 {
     /**
      * {@inheritdoc}
      */
-    public function describeInputArgument(InputArgument $argument, array $options = array())
+    protected function describeInputArgument(InputArgument $argument, array $options = array())
     {
         return '**'.$argument->getName().':**'."\n\n"
             .'* Name: '.($argument->getName() ?: '<none>')."\n"
@@ -40,7 +40,7 @@ public function describeInputArgument(InputArgument $argument, array $options =
     /**
      * {@inheritdoc}
      */
-    public function describeInputOption(InputOption $option, array $options = array())
+    protected function describeInputOption(InputOption $option, array $options = array())
     {
         return '**'.$option->getName().':**'."\n\n"
             .'* Name: `--'.$option->getName().'`'."\n"
@@ -55,7 +55,7 @@ public function describeInputOption(InputOption $option, array $options = array(
     /**
      * {@inheritdoc}
      */
-    public function describeInputDefinition(InputDefinition $definition, array $options = array())
+    protected function describeInputDefinition(InputDefinition $definition, array $options = array())
     {
         $blocks = array();
 
@@ -79,7 +79,7 @@ public function describeInputDefinition(InputDefinition $definition, array $opti
     /**
      * {@inheritdoc}
      */
-    public function describeCommand(Command $command, array $options = array())
+    protected function describeCommand(Command $command, array $options = array())
     {
         $command->getSynopsis();
         $command->mergeApplicationDefinition(false);
@@ -104,7 +104,7 @@ public function describeCommand(Command $command, array $options = array())
     /**
      * {@inheritdoc}
      */
-    public function describeApplication(Application $application, array $options = array())
+    protected function describeApplication(Application $application, array $options = array())
     {
         $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
         $description = new ApplicationDescription($application, $describedNamespace);

diff --git a/src/Symfony/Component/Console/Descriptor/TextDescriptor.php b/src/Symfony/Component/Console/Descriptor/TextDescriptor.php
@@ -22,12 +22,12 @@
  *
  * @author Jean-François Simon <contact@jfsimon.fr>
  */
-class TextDescriptor implements DescriptorInterface
+class TextDescriptor extends Descriptor
 {
     /**
      * {@inheritdo
10000
c}
      */
-    public function describeInputArgument(InputArgument $argument, array $options = array())
+    protected function describeInputArgument(InputArgument $argument, array $options = array())
     {
         if (null !== $argument->getDefault() && (!is_array($argument->getDefault()) || count($argument->getDefault()))) {
             $default = sprintf('<comment> (default: %s)</comment>', $this->formatDefaultValue($argument->getDefault()));
@@ -45,7 +45,7 @@ public function describeInputArgument(InputArgument $argument, array $options =
     /**
      * {@inheritdoc}
      */
-    public function describeInputOption(InputOption $option, array $options = array())
+    protected function describeInputOption(InputOption $option, array $options = array())
     {
         if ($option->acceptValue() && null !== $option->getDefault() && (!is_array($option->getDefault()) || count($option->getDefault()))) {
             $default = sprintf('<comment> (default: %s)</comment>', $this->formatDefaultValue($option->getDefault()));
@@ -70,7 +70,7 @@ public function describeInputOption(InputOption $option, array $options = array(
     /**
      * {@inheritdoc}
      */
-    public function describeInputDefinition(InputDefinition $definition, array $options = array())
+    protected function describeInputDefinition(InputDefinition $definition, array $options = array())
     {
         $nameWidth = 0;
         foreach ($definition->getOptions() as $option) {
@@ -111,7 +111,7 @@ public function describeInputDefinition(InputDefinition $definition, array $opti
     /**
      * {@inheritdoc}
      */
-    public function describeCommand(Command $command, array $options = array())
+    protected function describeCommand(Command $command, array $options = array())
     {
         $command->getSynopsis();
         $command->mergeApplicationDefinition(false);
@@ -136,7 +136,7 @@ public function describeCommand(Command $command, array $options = array())
     /**
      * {@inheritdoc}
      */
-    public function describeApplication(Application $application, array $options = array())
+    protected function describeApplication(Application $application, array $options = array())
     {
         $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
         $description = new ApplicationDescription($application, $describedNamespace);

diff --git a/src/Symfony/Component/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Component/Console/Descriptor/XmlDescriptor.php
@@ -22,12 +22,12 @@
  *
  * @author Jean-François Simon <contact@jfsimon.fr>
  */
-class XmlDescriptor implements DescriptorInterface
+class XmlDescriptor extends Descriptor
 {
     /**
      * {@inheritdoc}
      */
-    public function describeInputArgument(InputArgument $argument, array $options = array())
+    protected function describeInputArgument(InputArgument $argument, array $options = array())
     {
         $dom = new \DOMDocument('1.0', 'UTF-8');
 
@@ -51,7 +51,7 @@ public function describeInputArgument(InputArgument $argument, array $options =
     /**
      * {@inheritdoc}
      */
-    public function describeInputOption(InputOption $option, array $options = array())
+    protected function describeInputOption(InputOption $option, array $options = array())
     {
         $dom = new \DOMDocument('1.0', 'UTF-8');
 
@@ -82,7 +82,7 @@ public function describeInputOption(InputOption $option, array $options = array(
     /**
      * {@inheritdoc}
      */
-    public function describeInputDefinition(InputDefinition $definition, array $options = array())
+    protected function describeInputDefinition(InputDefinition $definition, array $options = array())
     {
         $dom = new \DOMDocument('1.0', 'UTF-8');
         $dom->appendChild($definitionXML = $dom->createElement('definition'));
@@ -103,7 +103,7 @@ public function describeInputDefinition(InputDefinition $definition, array $opti
     /**
      * {@inheritdoc}
      */
-    public function describeCommand(Command $command, array $options = array())
+    protected function describeCommand(Command $command, array $options = array())
     {
         $dom = new \DOMDocument('1.0', 'UTF-8');
         $dom->appendChild($commandXML = $dom->createElement('command'));
@@ -138,7 +138,7 @@ public function describeCommand(Command $command, array $options = array())
     /**
      * {@inheritdoc}
      */
-    public function describeApplication(Application $application, array $options = array())
+    protected function describeApplication(Application $application, array $options = array())
     {
         $dom = new \DOMDocument('1.0', 'UTF-8');
         $dom->appendChild($rootXml = $dom->createElement('symfony'));