123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242 |
- <?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;
- use Symfony\Component\Console\Exception\InvalidArgumentException;
- /**
- * Formatter class for console output.
- *
- * @author Konstantin Kudryashov <ever.zet@gmail.com>
- */
- class OutputFormatter implements OutputFormatterInterface
- {
- private $decorated;
- private $styles = array();
- private $styleStack;
- /**
- * Escapes "<" special char in given text.
- *
- * @param string $text Text to escape
- *
- * @return string Escaped text
- */
- public static function escape($text)
- {
- $text = preg_replace('/([^\\\\]?)</', '$1\\<', $text);
- return self::escapeTrailingBackslash($text);
- }
- /**
- * Escapes trailing "\" in given text.
- *
- * @param string $text Text to escape
- *
- * @return string Escaped text
- *
- * @internal
- */
- public static function escapeTrailingBackslash($text)
- {
- if ('\\' === substr($text, -1)) {
- $len = strlen($text);
- $text = rtrim($text, '\\');
- $text .= str_repeat('<<', $len - strlen($text));
- }
- return $text;
- }
- /**
- * Initializes console output formatter.
- *
- * @param bool $decorated Whether this formatter should actually decorate strings
- * @param OutputFormatterStyleInterface[] $styles Array of "name => FormatterStyle" instances
- */
- public function __construct($decorated = false, array $styles = array())
- {
- $this->decorated = (bool) $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);
- }
- $this->styleStack = new OutputFormatterStyleStack();
- }
- /**
- * {@inheritdoc}
- */
- public function setDecorated($decorated)
- {
- $this->decorated = (bool) $decorated;
- }
- /**
- * {@inheritdoc}
- */
- public function isDecorated()
- {
- return $this->decorated;
- }
- /**
- * {@inheritdoc}
- */
- public function setStyle($name, OutputFormatterStyleInterface $style)
- {
- $this->styles[strtolower($name)] = $style;
- }
- /**
- * {@inheritdoc}
- */
- public function hasStyle($name)
- {
- return isset($this->styles[strtolower($name)]);
- }
- /**
- * {@inheritdoc}
- */
- public function getStyle($name)
- {
- if (!$this->hasStyle($name)) {
- throw new InvalidArgumentException(sprintf('Undefined style: %s', $name));
- }
- return $this->styles[strtolower($name)];
- }
- /**
- * {@inheritdoc}
- */
- public function format($message)
- {
- $message = (string) $message;
- $offset = 0;
- $output = '';
- $tagRegex = '[a-z][a-z0-9,_=;-]*+';
- preg_match_all("#<(($tagRegex) | /($tagRegex)?)>#ix", $message, $matches, PREG_OFFSET_CAPTURE);
- foreach ($matches[0] as $i => $match) {
- $pos = $match[1];
- $text = $match[0];
- if (0 != $pos && '\\' == $message[$pos - 1]) {
- continue;
- }
- // add the text up to the next tag
- $output .= $this->applyCurrentStyle(substr($message, $offset, $pos - $offset));
- $offset = $pos + strlen($text);
- // opening tag?
- if ($open = '/' != $text[1]) {
- $tag = $matches[1][$i][0];
- } else {
- $tag = isset($matches[3][$i][0]) ? $matches[3][$i][0] : '';
- }
- if (!$open && !$tag) {
- // </>
- $this->styleStack->pop();
- } elseif (false === $style = $this->createStyleFromString(strtolower($tag))) {
- $output .= $this->applyCurrentStyle($text);
- } elseif ($open) {
- $this->styleStack->push($style);
- } else {
- $this->styleStack->pop($style);
- }
- }
- $output .= $this->applyCurrentStyle(substr($message, $offset));
- if (false !== strpos($output, '<<')) {
- return strtr($output, array('\\<' => '<', '<<' => '\\'));
- }
- return str_replace('\\<', '<', $output);
- }
- /**
- * @return OutputFormatterStyleStack
- */
- public function getStyleStack()
- {
- return $this->styleStack;
- }
- /**
- * Tries to create new style instance from string.
- *
- * @param string $string
- *
- * @return OutputFormatterStyle|false false if string is not format string
- */
- private function createStyleFromString($string)
- {
- if (isset($this->styles[$string])) {
- return $this->styles[$string];
- }
- if (!preg_match_all('/([^=]+)=([^;]+)(;|$)/', $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]);
- } elseif ('options' === $match[0]) {
- preg_match_all('([^,;]+)', $match[1], $options);
- $options = array_shift($options);
- foreach ($options as $option) {
- try {
- $style->setOption($option);
- } catch (\InvalidArgumentException $e) {
- @trigger_error(sprintf('Unknown style options are deprecated since version 3.2 and will be removed in 4.0. Exception "%s".', $e->getMessage()), E_USER_DEPRECATED);
- return false;
- }
- }
- } else {
- return false;
- }
- }
- return $style;
- }
- /**
- * Applies current style from stack to text, if must be applied.
- *
- * @param string $text Input text
- *
- * @return string Styled text
- */
- private function applyCurrentStyle($text)
- {
- return $this->isDecorated() && strlen($text) > 0 ? $this->styleStack->getCurrent()->apply($text) : $text;
- }
- }
|