added OutputDecorator

symfony · kbond · Sep 25, 2014 · Sep 25, 2014 · Sep 25, 2014 · Sep 25, 2014
commit e20283f8dc2bc46d40bb76e234bfdbeefb8615f5
diff --git a/src/Symfony/Component/Console/Helper/FormatterHelper.php b/src/Symfony/Component/Console/Helper/FormatterHelper.php
@@ -13,12 +13,7 @@
 
 use Symfony\Component\Console\Helper\Formatter\BlockFormatter;
 use Symfony\Component\Console\Helper\Formatter\FormatterInterface;
-use Symfony\Component\Console\Helper\Formatter\ListElementFormatter;
 use Symfony\Component\Console\Helper\Formatter\SectionFormatter;
-use Symfony\Component\Console\Helper\Formatter\SectionTitleFormatter;
-use Symfony\Component\Console\Helper\Formatter\StyledBlockFormatter;
-use Symfony\Component\Console\Helper\Formatter\TextFormatter;
-use Symfony\Component\Console\Helper\Formatter\TitleFormatter;
 
 /**
  * The Formatter class provides helpers to format messages.
@@ -66,114 +61,6 @@ public function formatBlock($messages, $style, $large = false, $padLength = 0)
         return $this->format(new BlockFormatter($messages, $style, $large, $padLength));
     }
 
-    /**
-     * Formats a command title
-     *
-     * @param string $message
-     *
-     * @return array
-     */
-    public function formatTitle($message)
-    {
-        return $this->format(new TitleFormatter($message));
-    }
-
-    /**
-     * Formats a section title
-     *
-     * @param string $message
-     *
-     * @return array
-     */
-    public function formatSectionTitle($message)
-    {
-        return $this->format(new SectionTitleFormatter($message));
-    }
-
-    /**
-     * Formats a list element
-     *
-     * @param string|array $messages
-     *
-     * @return array
-     */
-    public function formatListElement($messages)
-    {
-        return $this->format(new ListElementFormatter($messages));
-    }
-
-    /**
-     * Formats informational or debug text
-     *
-     * @param string|array $messages
-     *
-     * @return string
-     */
-    public function formatText($messages)
-    {
-        return $this->format(new TextFormatter($messages));
-    }
-
-    /**
-     * Formats a success result bar
-     *
-     * @param string|array $messages
-     *
-     * @return array
-     */
-    public function formatSuccessResultBar($messages)
-    {
-        return $this->format(new StyledBlockFormatter($messages, 'OK', 'fg=white;bg=green'));
-    }
-
-    /**
-     * Formats an error result bar
-     *
-     * @param string|array $messages
-     *
-     * @return array
-     */
-    public function formatErrorResultBar($messages)
-    {
-        return $this->format(new StyledBlockFormatter($messages, 'ERROR', 'fg=white;bg=red'));
-    }
-
-    /**
-     * Formats an warning result bar
-     *
-     * @param string|array $messages
-     *
-     * @return array
-     */
-    public function formatWarningResultBar($messages)
-    {
-        return $this->format(new StyledBlockFormatter($messages, 'WARNING', 'fg=black;bg=yellow'));
-    }
-
-    /**
-     * Formats a note admonition
-     *
-     * @param string|array $messages
-     *
-     * @return array
-     */
-    public function formatNoteBlock($messages)
-    {
-        return $this->format(new StyledBlockFormatter($messages, 'NOTE', 'fg=white', '! '));
-    }
-
-    /**
-     * Formats a caution admonition
-     *
-     * @param string|array $messages
-     *
-     * @return array
-     */
-    public function formatCautionBlock($messages)
-    {
-        return $this->format(new StyledBlockFormatter($messages, 'CAUTION', 'fg=white;bg=red', '! '));
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Symfony/Component/Console/Output/OutputDecorator.php b/src/Symfony/Component/Console/Output/OutputDecorator.php
@@ -0,0 +1,216 @@
+<?php
+
+namespace Symfony\Component\Console\Output;
+
+use Symfony\Component\Console\Formatter\OutputFormatterInterface;
+use Symfony\Component\Console\Helper\Formatter\BlockFormatter;
+use Symfony\Component\Console\Helper\Formatter\FormatterInterface;
+use Symfony\Component\Console\Helper\Formatter\ListElementFormatter;
+use Symfony\Component\Console\Helper\Formatter\SectionFormatter;
+use Symfony\Component\Console\Helper\Formatter\SectionTitleFormatter;
+use Symfony\Component\Console\Helper\Formatter\StyledBlockFormatter;
+use Symfony\Component\Console\Helper\Formatter\TextFormatter;
+use Symfony\Component\Console\Helper\Formatter\TitleFormatter;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class OutputDecorator implements OutputInterface
+{
+    private $output;
+
+    /**
+     * @param OutputInterface $output
+     */
+    public function __construct(OutputInterface $output)
+    {
+        $this->output = $output;
+    }
+
+    /**
+     * @param FormatterInterface $formatter
+     */
+    public function format(FormatterInterface $formatter)
+    {
+        $this->writeln($formatter->format());
+    }
+
+    /**
+     * Formats a message within a section.
+     *
+     * @param string $section The section name
+     * @param string $message The message
+     * @param string $style   The style to apply to the section
+     */
+    public function section($section, $message, $style = 'info')
+    {
+        $this->format(new SectionFormatter($section, $message, $style));
+    }
+
+    /**
+     * Formats a message as a block of text.
+     *
+     * @param string|array $messages  The message to write in the block
+     * @param string       $style     The style to apply to the whole block
+     * @param bool         $large     Whether to return a large block
+     * @param int          $padLength Length to pad the messages
+     */
+    public function block($messages, $style, $large = false, $padLength = 0)
+    {
+        $this->format(new BlockFormatter($messages, $style, $large, $padLength));
+    }
+
+    /**
+     * Formats a command title
+     *
+     * @param string $message
+     */
+    public function title($message)
+    {
+        $this->format(new TitleFormatter($message));
+    }
+
+    /**
+     * Formats a section title
+     *
+     * @param string $message
+     */
+    public function subtitle($message)
+    {
+        $this->format(new SectionTitleFormatter($message));
+    }
+
+    /**
+     * Formats a list element
+     *
+     * @param string|array $messages
+     */
+    public function listElement($messages)
+    {
+        $this->format(new ListElementFormatter($messages));
+    }
+
+    /**
+     * Formats informational or debug text
+     *
+     * @param string|array $messages
+     */
+    public function text($messages)
+    {
+        $this->format(new TextFormatter($messages));
+    }
+
+    /**
+     * Formats a success result bar
+     *
+     * @param string|array $messages
+     */
+    public function success($messages)
+    {
+        $this->format(new StyledBlockFormatter($messages, 'OK', 'fg=white;bg=green'));
+    }
+
+    /**
+     * Formats an error result bar
+     *
+     * @param string|array $messages
+     */
+    public function error($messages)
+    {
+        $this->format(new StyledBlockFormatter($messages, 'ERROR', 'fg=white;bg=red'));
+    }
+
+    /**
+     * Formats an warning result bar
+     *
+     * @param string|array $messages
+     */
+    public function warning($messages)
+    {
+        $this->format(new StyledBlockFormatter($messages, 'WARNING', 'fg=black;bg=yellow'));
+    }
+
+    /**
+     * Formats a note admonition
+     *
+     * @param string|array $messages
+     */
+    public function note($messages)
+    {
+        $this->format(new StyledBlockFormatter($messages, 'NOTE', 'fg=white', '! '));
+    }
+
+    /**
+     * Formats a caution admonition
+     *
+     * @param string|array $messages
+     */
+    public function caution($messages)
+    {
+        $this->format(new StyledBlockFormatter($messages, 'CAUTION', 'fg=white;bg=red', '! '));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL)
+    {
+        $this->output->write($messages, $newline, $type);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function writeln($messages, $type = self::OUTPUT_NORMAL)
+    {
+        $this->output->writeln($messages, $type);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setVerbosity($level)
+    {
+        $this->output->setVerbosity($level);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getVerbosity()
+    {
+        return $this->output->getVerbosity();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setDecorated($decorated)
+    {
+        $this->output->setDecorated($decorated);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isDecorated()
+    {
+        return $this->output->isDecorated();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setFormatter(OutputFormatterInterface $formatter)
+    {
+        $this->output->setFormatter($formatter);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormatter()
+    {
+        return $this->output->getFormatter();
+    }
+}