[Console] applied advices from github comments

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit d3ec07335fc460f7dae470255ba2de173b7c6323
diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php b/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php
@@ -1,5 +1,14 @@
 <?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;
 
 use Symfony\Component\Console\Application;
@@ -16,45 +25,50 @@
 interface DescriptorInterface
 {
     /**
-     * @param InputArgument $argument
+     * Describes an InputArgument instance.
      *
-     * @param array $options
+     * @param InputArgument $argument
+     * @param array         $options
      *
      * @return string|mixed
      */
     public function describeInputArgument(InputArgument $argument, array $options = array());
 
     /**
-     * @param InputOption $option
+     * Describes an InputOption instance.
      *
-     * @param array $options
+     * @param InputOption $option
+     * @param array       $options
      *
      * @return string|mixed
      */
     public function describeInputOption(InputOption $option, array $options = array());
 
     /**
-     * @param InputDefinition $definition
+     * Describes an InputDefinition instance.
      *
-     * @param array $options
+     * @param InputDefinition $definition
+     * @param array           $options
      *
      * @return string|mixed
      */
     public function describeInputDefinition(InputDefinition $definition, array $options = array());
 
     /**
-     * @param Command $command
+     * Describes a Command instance.
      *
-     * @param array $options
+     * @param Command $command
+     * @param array   $options
      *
      * @return string|mixed
      */
     public function describeCommand(Command $command, array $options = array());
 
     /**
-     * @param Application $application
+     * Describes an Application instance.
      *
-     * @param array $options
+     * @param Application $application
+     * @param array       $options
      *
      * @return string|mixed
      */

diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorProxy.php b/src/Symfony/Component/Console/Descriptor/DescriptorProxy.php
@@ -1,5 +1,14 @@
 <?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;
 
 use Symfony\Component\Console\Application;
@@ -66,14 +75,42 @@ public function register($format, DescriptorInterface $descriptor)
         return $this;
     }
 
+    /**
+     * Describes given object.
+     *
+     * @param object $object
+     * @param array  $options
+     *
+     * @return mixed|string
+     *
+     * @throws \InvalidArgumentException
+     */
+    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)));
+    }
+
     /**
      * {@inheritdoc}
      */
     public function describeInputArgument(InputArgument $argument, array $options = array())
     {
         $options = array_merge($this->defaultOptions, $options);
 
-        return $this->descriptors[$options['format']]->describeInputArgument($argument, $options);
+        return $this->getDescriptor($options['format'])->describeInputArgument($argument, $options);
     }
 
     /**
@@ -83,7 +120,7 @@ public function describeInputOption(InputOption $option, array $options = array(
     {
         $options = array_merge($this->defaultOptions, $options);
 
-        return $this->descriptors[$options['format']]->describeInputOption($option, $options);
+        return $this->getDescriptor($options['format'])->describeInputOption($option, $options);
     }
 
     /**
@@ -93,7 +130,7 @@ public function describeInputDefinition(InputDefinition $definition, array $opti
     {
         $options = array_merge($this->defaultOptions, $options);
 
-        return $this->descriptors[$options['format']]->describeInputDefinition($definition, $options);
+        return $this->getDescriptor($options['format'])->describeInputDefinition($definition, $options);
     }
 
     /**
@@ -103,7 +140,7 @@ public function describeCommand(Command $command, array $options = array())
     {
         $options = array_merge($this->defaultOptions, $options);
 
-        return $this->descriptors[$options['format']]->describeCommand($command, $options);
+        return $this->getDescriptor($options['format'])->describeCommand($command, $options);
     }
 
     /**
@@ -113,6 +150,24 @@ public function describeApplication(Application $application, array $options = a
     {
         $options = array_merge($this->defaultOptions, $options);
 
-        return $this->descriptors[$options['format']]->describeApplication($application, $options);
+        return $this->getDescriptor($options['format'])->describeApplication($application, $options);
+    }
+
+    /**
+     * Returns a descriptor according to gievn format.
+     *
+     * @param string $format
+     *
+     * @throws \InvalidArgumentException
+     *
+     * @return DescriptorInterface
+     */
+    private function getDescriptor($format)
+    {
+        if (!isset($this->descriptors[$format])) {
+            throw new \InvalidArgumentException(sprintf('Unsupported format "%s".', $format));
+        }
+
+        return $this->descriptors[$format];
     }
 }
diff --git a/src/Symfony/Component/Console/Descriptor/JsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/JsonDescriptor.php
@@ -1,5 +1,14 @@
 <?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;
 
 use Symfony\Component\Console\Application;

diff --git a/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php
@@ -1,5 +1,14 @@
 <?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;
 
 use Symfony\Component\Console\Application;

diff --git a/src/Symfony/Component/Console/Descriptor/TextDescriptor.php b/src/Symfony/Component/Console/Descriptor/TextDescriptor.php
@@ -1,5 +1,14 @@
 <?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;
 
 use Symfony\Component\Console\Application;

diff --git a/src/Symfony/Component/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Component/Console/Descriptor/XmlDescriptor.php
@@ -1,5 +1,14 @@
 <?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;
 
 use Symfony\Component\Console\Application;

diff --git a/src/Symfony/Component/Console/Helper/DescriptorHelper.php b/src/Symfony/Component/Console/Helper/DescriptorHelper.php
@@ -54,7 +54,7 @@ public function describe(OutputInterface $output, $object, $format = null, $raw
         $options = array('raw_text' => $raw, 'format' => $format ?: 'txt');
         $type = !$raw && 'txt' === $options['format'] ? OutputInterface::OUTPUT_NORMAL : OutputInterface::OUTPUT_RAW;
 
-        $output->writeln($this->getDescription($object, $options), $type);
+        $output->writeln($this->descriptor->describe($object, $options), $type);
     }
 
     /**
@@ -64,22 +64,4 @@ public function getName()
     {
         return 'descriptor';
     }
-
-    private function getDescription($object, array $options)
-    {
-        switch (true) {
-            case $object instanceof InputArgument:
-                return $this->descriptor->describeInputArgument($object, $options);
-            case $object instanceof InputOption:
-                return $this->descriptor->describeInputOption($object, $options);
-            case $object instanceof InputDefinition:
-                return $this->descriptor->describeInputDefinition($object, $options);
-            case $object instanceof Command:
-                return $this->descriptor->describeCommand($object, $options);
-            case $object instanceof Application:
-                return $this->descriptor->describeApplication($object, $options);
-        }
-
-        throw new \InvalidArgumentException(sprintf('Object of type "%s" is not describable.', get_class($object)));
-    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Descriptor/JsonDescriptorTest.php b/src/Symfony/Component/Console/Tests/Descriptor/JsonDescriptorTest.php
@@ -1,5 +1,14 @@
 <?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\Tests\Descriptor;
 
 use Symfony\Component\Console\Descriptor\JsonDescriptor;

diff --git a/src/Symfony/Component/Console/Tests/Descriptor/MarkdownDescriptorTest.php b/src/Symfony/Component/Console/Tests/Descriptor/MarkdownDescriptorTest.php
@@ -1,5 +1,14 @@
 <?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\Tests\Descriptor;
 
 use Symfony\Component\Console\Descriptor\MarkdownDescriptor;

diff --git a/src/Symfony/Component/Console/Tests/Descriptor/TextDescriptorTest.php b/src/Symfony/Component/Console/Tests/Descriptor/TextDescriptorTest.php
@@ -1,5 +1,14 @@
 <?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\Tests\Descriptor;
 
 use Symfony\Component\Console\Descriptor\TextDescriptor;

diff --git a/src/Symfony/Component/Console/Tests/Descriptor/XmlDescriptorTest.php b/src/Symfony/Component/Console/Tests/Descriptor/XmlDescriptorTest.php
@@ -1,5 +1,14 @@
 <?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\Tests\Descriptor;
 
 use Symfony\Component\Console\Descriptor\XmlDescriptor;