OutputFormatter::format() - Code Metrics - webcol/Calima - Measure and Improve Code Quality continuously with Scrutinizer

OutputFormatter::format() D
last analyzed 2017-12-14 01:15 UTC

↳ Parent: OutputFormatter

Complexity

Conditions	10
Paths	14

Size

Total Lines	41
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	26
nc	14
nop	1
dl	0
loc	41
rs	4.8196
c	0
b	0
f	0

How to fix Complexity

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

/**
 * Formatter class for console output.
 *
 * @author Konstantin Kudryashov <[email protected]>
 *
 * @api
 */
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)
    {
        return preg_replace('/([^\\\\]?)</is', '$1\\<', $text);
    }

    /**
     * Initializes console output formatter.
     *
     * @param bool                            $decorated Whether this formatter should actually decorate strings
     * @param OutputFormatterStyleInterface[] $styles    Array of "name => FormatterStyle" instances
     *
     * @api
     */
    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
     *
     * @api
     */
    public function setDecorated($decorated)
    {
        $this->decorated = (bool) $decorated;
    }

    /**
     * Gets the decorated flag.
     *
     * @return bool 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 $style 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 bool
     *
     * @api
     */
    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
     *
     * @api
     */
    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
     *
     * @api
     */
    public function format($message)
    {
        $offset = 0;
        $output = '';
        $tagRegex = '[a-z][a-z0-9_=;-]*';
        preg_match_all("#<(($tagRegex) | /($tagRegex)?)>#isx", $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);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            } else {
                $this->styleStack->pop($style);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            }
        }

        $output .= $this->applyCurrentStyle(substr($message, $offset));

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


GitHub Access Token became invalid

OutputFormatter::format() D
last analyzed 2017-12-14 01:15 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

1			<?php
2
3			/*
4			* This file is part of the Symfony package.
5			*
6			* (c) Fabien Potencier <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Symfony\Component\Console\Formatter;
13
14			/**
15			* Formatter class for console output.
16			*
17			* @author Konstantin Kudryashov <[email protected]>
18			*
19			* @api
20			*/
21			class OutputFormatter implements OutputFormatterInterface
22			{
23			private $decorated;
24			private $styles = array();
25			private $styleStack;
26
27			/**
28			* Escapes "<" special char in given text.
29			*
30			* @param string $text Text to escape
31			*
32			* @return string Escaped text
33			*/
34			public static function escape($text)
35			{
36			return preg_replace('/([^\\\\]?)</is', '$1\\<', $text);
37			}
38
39			/**
40			* Initializes console output formatter.
41			*
42			* @param bool $decorated Whether this formatter should actually decorate strings
43			* @param OutputFormatterStyleInterface[] $styles Array of "name => FormatterStyle" instances
44			*
45			* @api
46			*/
47			public function __construct($decorated = false, array $styles = array())
48			{
49			$this->decorated = (bool) $decorated;
50
51			$this->setStyle('error', new OutputFormatterStyle('white', 'red'));
52			$this->setStyle('info', new OutputFormatterStyle('green'));
53			$this->setStyle('comment', new OutputFormatterStyle('yellow'));
54			$this->setStyle('question', new OutputFormatterStyle('black', 'cyan'));
55
56			foreach ($styles as $name => $style) {
57			$this->setStyle($name, $style);
58			}
59
60			$this->styleStack = new OutputFormatterStyleStack();
61			}
62
63			/**
64			* Sets the decorated flag.
65			*
66			* @param bool $decorated Whether to decorate the messages or not
67			*
68			* @api
69			*/
70			public function setDecorated($decorated)
71			{
72			$this->decorated = (bool) $decorated;
73			}
74
75			/**
76			* Gets the decorated flag.
77			*
78			* @return bool true if the output will decorate messages, false otherwise
79			*
80			* @api
81			*/
82			public function isDecorated()
83			{
84			return $this->decorated;
85			}
86
87			/**
88			* Sets a new style.
89			*
90			* @param string $name The style name
91			* @param OutputFormatterStyleInterface $style The style instance
92			*
93			* @api
94			*/
95			public function setStyle($name, OutputFormatterStyleInterface $style)
96			{
97			$this->styles[strtolower($name)] = $style;
98			}
99
100			/**
101			* Checks if output formatter has style with specified name.
102			*
103			* @param string $name
104			*
105			* @return bool
106			*
107			* @api
108			*/
109			public function hasStyle($name)
110			{
111			return isset($this->styles[strtolower($name)]);
112			}
113
114			/**
115			* Gets style options from style with specified name.
116			*
117			* @param string $name
118			*
119			* @return OutputFormatterStyleInterface
120			*
121			* @throws \InvalidArgumentException When style isn't defined
122			*
123			* @api
124			*/
125			public function getStyle($name)
126			{
127			if (!$this->hasStyle($name)) {
128			throw new \InvalidArgumentException(sprintf('Undefined style: %s', $name));
129			}
130
131			return $this->styles[strtolower($name)];
132			}
133
134			/**
135			* Formats a message according to the given styles.
136			*
137			* @param string $message The message to style
138			*
139			* @return string The styled message
140			*
141			* @api
142			*/
143			public function format($message)
144			{
145			$offset = 0;
146			$output = '';
147			$tagRegex = '[a-z][a-z0-9_=;-]*';
148			preg_match_all("#<(($tagRegex) \| /($tagRegex)?)>#isx", $message, $matches, PREG_OFFSET_CAPTURE);
149			foreach ($matches[0] as $i => $match) {
150			$pos = $match[1];
151			$text = $match[0];
152
153			if (0 != $pos && '\\' == $message[$pos - 1]) {
154			continue;
155			}
156
157			// add the text up to the next tag
158			$output .= $this->applyCurrentStyle(substr($message, $offset, $pos - $offset));
159			$offset = $pos + strlen($text);
160
161			// opening tag?
162			if ($open = '/' != $text[1]) {
163			$tag = $matches[1][$i][0];
164			} else {
165			$tag = isset($matches[3][$i][0]) ? $matches[3][$i][0] : '';
166			}
167
168			if (!$open && !$tag) {
169			// </>
170			$this->styleStack->pop();
171			} elseif (false === $style = $this->createStyleFromString(strtolower($tag))) {
172			$output .= $this->applyCurrentStyle($text);
173			} elseif ($open) {
174			$this->styleStack->push($style);
			0 ignored issues – show Bug introduced 2016-02-17 21:17 UTC by Report Bug Copy Issue Report It seems like `$style` defined by `$this->createStyleFromString(strtolower($tag))` on line `171` can also be of type `boolean`; however, `Symfony\Component\Consol...atterStyleStack::push()` does only seem to accept `object<Symfony\Component...ormatterStyleInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
175			} else {
176			$this->styleStack->pop($style);
			0 ignored issues – show Bug introduced 2016-02-17 21:17 UTC by Report Bug Copy Issue Report It seems like `$style` defined by `$this->createStyleFromString(strtolower($tag))` on line `171` can also be of type `boolean`; however, `Symfony\Component\Consol...matterStyleStack::pop()` does only seem to accept `null\|object<Symfony\Comp...ormatterStyleInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
177			}
178			}
179
180			$output .= $this->applyCurrentStyle(substr($message, $offset));
181
182			return str_replace('\\<', '<', $output);
183			}
184
185			/**
186			* @return OutputFormatterStyleStack
187			*/
188			public function getStyleStack()
189			{
190			return $this->styleStack;
191			}
192
193			/**
194			* Tries to create new style instance from string.
195			*
196			* @param string $string
197			*
198			* @return OutputFormatterStyle\|bool false if string is not format string
199			*/
200			private function createStyleFromString($string)
201			{
202			if (isset($this->styles[$string])) {
203			return $this->styles[$string];
204			}
205
206			if (!preg_match_all('/([^=]+)=([^;]+)(;\|$)/', strtolower($string), $matches, PREG_SET_ORDER)) {
207			return false;
208			}
209
210			$style = new OutputFormatterStyle();
211			foreach ($matches as $match) {
212			array_shift($match);
213
214			if ('fg' == $match[0]) {
215			$style->setForeground($match[1]);
216			} elseif ('bg' == $match[0]) {
217			$style->setBackground($match[1]);
218			} else {
219			try {
220			$style->setOption($match[1]);
221			} catch (\InvalidArgumentException $e) {
222			return false;
223			}
224			}
225			}
226
227			return $style;
228			}
229
230			/**
231			* Applies current style from stack to text, if must be applied.
232			*
233			* @param string $text Input text
234			*
235			* @return string Styled text
236			*/
237			private function applyCurrentStyle($text)
238			{
239			return $this->isDecorated() && strlen($text) > 0 ? $this->styleStack->getCurrent()->apply($text) : $text;
240			}
241			}
242

webcol / Calima

GitHub Access Token became invalid

OutputFormatter::format() D last analyzed 2017-12-14 01:15 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

OutputFormatter::format() D
last analyzed 2017-12-14 01:15 UTC