symfony/src/Symfony/Component/Console/Formatter/OutputFormatter.php

<?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\Formatter;

/**
 * Formatter class for console output.
 *
 * @author Konstantin Kudryashov <ever.zet@gmail.com>
 *
 * @api
 */
class OutputFormatter implements OutputFormatterInterface
{
    private $decorated;
    private $styles = array();

    /**
     * Initializes console output formatter.
     *
     * @param   boolean $decorated  Whether this formatter should actually decorate strings
     * @param   array   $styles     Array of "name => FormatterStyle" instance
     *
     * @api
     */
    public function __construct($decorated = null, array $styles = array())
    {
        $this->decorated = (Boolean) $decorated;

        $this->setStyle('error',    new OutputFormatterStyle('white', 'red'));
        $this->setStyle('info',     new OutputFormatterStyle('green'));
        $this->setStyle('comment',  new OutputFormatterStyle('yellow'));
        $this->setStyle('question', new OutputFormatterStyle('black', 'cyan'));

        foreach ($styles as $name => $style) {
            $this->setStyle($name, $style);
        }
    }

    /**
     * Sets the decorated flag.
     *
     * @param Boolean $decorated Whether to decorated the messages or not
     *
     * @api
     */
    public function setDecorated($decorated)
    {
        $this->decorated = (Boolean) $decorated;
    }

    /**
     * Gets the decorated flag.
     *
     * @return Boolean true if the output will decorate messages, false otherwise
     *
     * @api
     */
    public function isDecorated()
    {
        return $this->decorated;
    }

    /**
     * Sets a new style.
     *
     * @param   string                          $name     The style name
     * @param   OutputFormatterStyleInterface   $options  The style instance
     *
     * @api
     */
    public function setStyle($name, OutputFormatterStyleInterface $style)
    {
        $this->styles[strtolower($name)] = $style;
    }

    /**
     * Checks if output formatter has style with specified name.
     *
     * @param   string  $name
     *
     * @return  boolean
     *
     * @api
     */
    public function hasStyle($name)
    {
        return isset($this->styles[strtolower($name)]);
    }

    /**
     * Gets style options from style with specified name.
     *
     * @param   string  $name
     *
     * @return  OutputFormatterStyleInterface
     *
     * @api
     */
    public function getStyle($name)
    {
        if (!$this->hasStyle($name)) {
            throw new \InvalidArgumentException('Undefined style: ' . $name);
        }

        return $this->styles[strtolower($name)];
    }

    /**
     * Formats a message according to the given styles.
     *
     * @param  string $message The message to style
     *
     * @return string The styled message
     *
     * @api
     */
    public function format($message)
    {
        $message = preg_replace_callback(
            $this->getBeginStyleRegex(), array($this, 'replaceBeginStyle'), $message
        );

        return preg_replace_callback(
            $this->getEndStyleRegex(), array($this, 'replaceEndStyle'), $message
        );
    }

    /**
     * Gets regex for a style start.
     *
     * @return  string
     */
    protected function getBeginStyleRegex()
    {
        return '#<([a-z][a-z0-9\-_=;]+)>#i';
    }

    /**
     * Gets regex for a style end.
     *
     * @return  string
     */
    protected function getEndStyleRegex()
    {
        return '#</([a-z][a-z0-9\-_]*)?>#i';
    }

    /**
     * Replaces the starting style of the output.
     *
     * @param array $match
     *
     * @return string The replaced style
     *
     * @throws \InvalidArgumentException When style is unknown
     */
    private function replaceBeginStyle($match)
    {
        if (!$this->isDecorated()) {
            return '';
        }

        if (isset($this->styles[strtolower($match[1])])) {
            $style = $this->styles[strtolower($match[1])];
        } else {
            $style = $this->createStyleFromString($match[1]);

            if (false === $style) {
                return $match[0];
            }
        }

        return $style->getBeginStyle();
    }

    /**
     * Replaces the end style.
     *
     * @param string $match The text to match
     *
     * @return string The end style
     */
    private function replaceEndStyle($match)
    {
        if (!$this->isDecorated()) {
            return '';
        }

        if (!isset($match[1])) {
            $match[1] = '';
        }

        if ('' == $match[1]) {
            $style = new OutputFormatterStyle();
        } else {
            if (!isset($this->styles[strtolower($match[1])])) {
                return $match[0];
            }

            $style = $this->styles[strtolower($match[1])];
        }

        return $style->getEndStyle();
    }

    /**
     * Tryes to create new style instance from string.
     *
     * @param   string  $string
     *
     * @return  Symfony\Component\Console\Format\FormatterStyle|boolean false if string is not format string
     */
    private function createStyleFromString($string)
    {
        if (!preg_match_all('/([^=]+)=([^;]+)(;|$)/', strtolower($string), $matches, PREG_SET_ORDER)) {
            return false;
        }

        $style = new OutputFormatterStyle();
        foreach ($matches as $match) {
            array_shift($match);

            if ('fg' == $match[0]) {
                $style->setForeground($match[1]);
            } elseif ('bg' == $match[0]) {
                $style->setBackground($match[1]);
            } else {
                $style->setOption($match[1]);
            }
        }

        return $style;
    }
}