Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • BarBucCommand
  • Evenement\EventEmitter
  • Foo1Command
  • Foo2Command
  • Foo3Command
  • Foo4Command
  • Foo5Command
  • Foo6Command
  • FoobarCommand
  • FooCommand
  • FooSubnamespaced1Command
  • FooSubnamespaced2Command
  • Peridot\Configuration
  • Peridot\Console\Application
  • Peridot\Console\CliOptionParser
  • Peridot\Console\Command
  • Peridot\Console\ConfigurationReader
  • Peridot\Console\Environment
  • Peridot\Console\InputDefinition
  • Peridot\Console\Version
  • Peridot\Core\AbstractTest
  • Peridot\Core\Scope
  • Peridot\Core\Suite
  • Peridot\Core\Test
  • Peridot\Core\TestResult
  • Peridot\Reporter\AbstractBaseReporter
  • Peridot\Reporter\AnonymousReporter
  • Peridot\Reporter\CompositeReporter
  • Peridot\Reporter\ReporterFactory
  • Peridot\Reporter\SpecReporter
  • Peridot\Runner\Context
  • Peridot\Runner\Runner
  • Peridot\Runner\SuiteLoader
  • Peridot\Scope\Scope
  • Peridot\Test\ItWasRun
  • Symfony\Component\Console\Application
  • Symfony\Component\Console\Command\Command
  • Symfony\Component\Console\Command\HelpCommand
  • Symfony\Component\Console\Command\ListCommand
  • Symfony\Component\Console\ConsoleEvents
  • Symfony\Component\Console\Event\ConsoleCommandEvent
  • Symfony\Component\Console\Event\ConsoleEvent
  • Symfony\Component\Console\Event\ConsoleExceptionEvent
  • Symfony\Component\Console\Event\ConsoleTerminateEvent
  • Symfony\Component\Console\Formatter\OutputFormatter
  • Symfony\Component\Console\Formatter\OutputFormatterStyle
  • Symfony\Component\Console\Formatter\OutputFormatterStyleStack
  • Symfony\Component\Console\Helper\DebugFormatterHelper
  • Symfony\Component\Console\Helper\DescriptorHelper
  • Symfony\Component\Console\Helper\DialogHelper
  • Symfony\Component\Console\Helper\FormatterHelper
  • Symfony\Component\Console\Helper\Helper
  • Symfony\Component\Console\Helper\HelperSet
  • Symfony\Component\Console\Helper\InputAwareHelper
  • Symfony\Component\Console\Helper\ProcessHelper
  • Symfony\Component\Console\Helper\ProgressBar
  • Symfony\Component\Console\Helper\ProgressHelper
  • Symfony\Component\Console\Helper\ProgressIndicator
  • Symfony\Component\Console\Helper\QuestionHelper
  • Symfony\Component\Console\Helper\SymfonyQuestionHelper
  • Symfony\Component\Console\Helper\Table
  • Symfony\Component\Console\Helper\TableCell
  • Symfony\Component\Console\Helper\TableHelper
  • Symfony\Component\Console\Helper\TableSeparator
  • Symfony\Component\Console\Helper\TableStyle
  • Symfony\Component\Console\Input\ArgvInput
  • Symfony\Component\Console\Input\ArrayInput
  • Symfony\Component\Console\Input\Input
  • Symfony\Component\Console\Input\InputArgument
  • Symfony\Component\Console\Input\InputDefinition
  • Symfony\Component\Console\Input\InputOption
  • Symfony\Component\Console\Input\StringInput
  • Symfony\Component\Console\Logger\ConsoleLogger
  • Symfony\Component\Console\Output\BufferedOutput
  • Symfony\Component\Console\Output\ConsoleOutput
  • Symfony\Component\Console\Output\NullOutput
  • Symfony\Component\Console\Output\Output
  • Symfony\Component\Console\Output\StreamOutput
  • Symfony\Component\Console\Question\ChoiceQuestion
  • Symfony\Component\Console\Question\ConfirmationQuestion
  • Symfony\Component\Console\Question\Question
  • Symfony\Component\Console\Shell
  • Symfony\Component\Console\Style\OutputStyle
  • Symfony\Component\Console\Style\SymfonyStyle
  • Symfony\Component\Console\Tester\ApplicationTester
  • Symfony\Component\Console\Tester\CommandTester
  • Symfony\Component\Console\Tests\ApplicationTest
  • Symfony\Component\Console\Tests\Command\CommandTest
  • Symfony\Component\Console\Tests\Command\HelpCommandTest
  • Symfony\Component\Console\Tests\Command\ListCommandTest
  • Symfony\Component\Console\Tests\CustomApplication
  • Symfony\Component\Console\Tests\CustomDefaultCommandApplication
  • Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\JsonDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\MarkdownDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\ObjectsProvider
  • Symfony\Component\Console\Tests\Descriptor\TextDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\XmlDescriptorTest
  • Symfony\Component\Console\Tests\Fixtures\DescriptorApplication1
  • Symfony\Component\Console\Tests\Fixtures\DescriptorApplication2
  • Symfony\Component\Console\Tests\Fixtures\DescriptorCommand1
  • Symfony\Component\Console\Tests\Fixtures\DescriptorCommand2
  • Symfony\Component\Console\Tests\Fixtures\DummyOutput
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterStyleStackTest
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterStyleTest
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterTest
  • Symfony\Component\Console\Tests\Formatter\TableCell
  • Symfony\Component\Console\Tests\Helper\FormatterHelperTest
  • Symfony\Component\Console\Tests\Helper\HelperSetTest
  • Symfony\Component\Console\Tests\Helper\HelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyDialogHelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyProgressHelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyTableHelperTest
  • Symfony\Component\Console\Tests\Helper\ProcessHelperTest
  • Symfony\Component\Console\Tests\Helper\ProgressBarTest
  • Symfony\Component\Console\Tests\Helper\ProgressIndicatorTest
  • Symfony\Component\Console\Tests\Helper\QuestionHelperTest
  • Symfony\Component\Console\Tests\Helper\SymfonyQuestionHelperTest
  • Symfony\Component\Console\Tests\Helper\TableStyleTest
  • Symfony\Component\Console\Tests\Helper\TableTest
  • Symfony\Component\Console\Tests\Input\ArgvInputTest
  • Symfony\Component\Console\Tests\Input\ArrayInputTest
  • Symfony\Component\Console\Tests\Input\InputArgumentTest
  • Symfony\Component\Console\Tests\Input\InputDefinitionTest
  • Symfony\Component\Console\Tests\Input\InputOptionTest
  • Symfony\Component\Console\Tests\Input\InputTest
  • Symfony\Component\Console\Tests\Input\StringInputTest
  • Symfony\Component\Console\Tests\Logger\ConsoleLoggerTest
  • Symfony\Component\Console\Tests\Output\ConsoleOutputTest
  • Symfony\Component\Console\Tests\Output\NullOutputTest
  • Symfony\Component\Console\Tests\Output\OutputTest
  • Symfony\Component\Console\Tests\Output\StreamOutputTest
  • Symfony\Component\Console\Tests\Output\TestOutput
  • Symfony\Component\Console\Tests\Style\SymfonyStyleTest
  • Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength
  • Symfony\Component\Console\Tests\Tester\ApplicationTesterTest
  • Symfony\Component\Console\Tests\Tester\CommandTesterTest
  • TestCommand

Interfaces

  • Evenement\EventEmitterInterface
  • Peridot\Core\TestInterface
  • Peridot\Reporter\ReporterInterface
  • Peridot\Runner\RunnerInterface
  • Peridot\Runner\SuiteLoaderInterface
  • Symfony\Component\Console\Descriptor\DescriptorInterface
  • Symfony\Component\Console\Exception\ExceptionInterface
  • Symfony\Component\Console\Formatter\OutputFormatterInterface
  • Symfony\Component\Console\Formatter\OutputFormatterStyleInterface
  • Symfony\Component\Console\Helper\HelperInterface
  • Symfony\Component\Console\Input\InputAwareInterface
  • Symfony\Component\Console\Input\InputInterface
  • Symfony\Component\Console\Output\ConsoleOutputInterface
  • Symfony\Component\Console\Output\OutputInterface
  • Symfony\Component\Console\Style\StyleInterface

Traits

  • Evenement\EventEmitterTrait
  • Peridot\Core\HasEventEmitterTrait
  • Peridot\Scope\ScopeTrait

Exceptions

  • Peridot\AssertException
  • Symfony\Component\Console\Exception\CommandNotFoundException
  • Symfony\Component\Console\Exception\InvalidArgumentException
  • Symfony\Component\Console\Exception\InvalidOptionException
  • Symfony\Component\Console\Exception\LogicException
  • Symfony\Component\Console\Exception\RuntimeException

Functions

  • afterEach
  • beforeEach
  • context
  • describe
  • fcontext
  • fdescribe
  • fit
  • it
  • Symfony\Component\Console\Tests\Command\createClosure
  • xcontext
  • xdescribe
  • xit
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 
<?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);

        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();
    }

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

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

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

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

    /**
     * Gets style options from style with specified name.
     *
     * @param string $name
     *
     * @return OutputFormatterStyleInterface
     *
     * @throws InvalidArgumentException When style isn't defined
     */
    public function getStyle($name)
    {
        if (!$this->hasStyle($name)) {
            throw new InvalidArgumentException(sprintf('Undefined style: %s', $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
     */
    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|bool false if string is not format string
     */
    private function createStyleFromString($string)
    {
        if (isset($this->styles[$string])) {
            return $this->styles[$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 {
                try {
                    $style->setOption($match[1]);
                } catch (\InvalidArgumentException $e) {
                    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;
    }
}
Peridot API documentation generated by ApiGen