annotate vendor/symfony/console/Formatter/OutputFormatterStyleStack.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Console\Formatter;
Chris@0 13
Chris@0 14 use Symfony\Component\Console\Exception\InvalidArgumentException;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * @author Jean-François Simon <contact@jfsimon.fr>
Chris@0 18 */
Chris@0 19 class OutputFormatterStyleStack
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * @var OutputFormatterStyleInterface[]
Chris@0 23 */
Chris@0 24 private $styles;
Chris@0 25
Chris@0 26 private $emptyStyle;
Chris@0 27
Chris@0 28 public function __construct(OutputFormatterStyleInterface $emptyStyle = null)
Chris@0 29 {
Chris@0 30 $this->emptyStyle = $emptyStyle ?: new OutputFormatterStyle();
Chris@0 31 $this->reset();
Chris@0 32 }
Chris@0 33
Chris@0 34 /**
Chris@0 35 * Resets stack (ie. empty internal arrays).
Chris@0 36 */
Chris@0 37 public function reset()
Chris@0 38 {
Chris@17 39 $this->styles = [];
Chris@0 40 }
Chris@0 41
Chris@0 42 /**
Chris@0 43 * Pushes a style in the stack.
Chris@0 44 */
Chris@0 45 public function push(OutputFormatterStyleInterface $style)
Chris@0 46 {
Chris@0 47 $this->styles[] = $style;
Chris@0 48 }
Chris@0 49
Chris@0 50 /**
Chris@0 51 * Pops a style from the stack.
Chris@0 52 *
Chris@0 53 * @return OutputFormatterStyleInterface
Chris@0 54 *
Chris@0 55 * @throws InvalidArgumentException When style tags incorrectly nested
Chris@0 56 */
Chris@0 57 public function pop(OutputFormatterStyleInterface $style = null)
Chris@0 58 {
Chris@0 59 if (empty($this->styles)) {
Chris@0 60 return $this->emptyStyle;
Chris@0 61 }
Chris@0 62
Chris@0 63 if (null === $style) {
Chris@0 64 return array_pop($this->styles);
Chris@0 65 }
Chris@0 66
Chris@0 67 foreach (array_reverse($this->styles, true) as $index => $stackedStyle) {
Chris@0 68 if ($style->apply('') === $stackedStyle->apply('')) {
Chris@17 69 $this->styles = \array_slice($this->styles, 0, $index);
Chris@0 70
Chris@0 71 return $stackedStyle;
Chris@0 72 }
Chris@0 73 }
Chris@0 74
Chris@0 75 throw new InvalidArgumentException('Incorrectly nested style tag found.');
Chris@0 76 }
Chris@0 77
Chris@0 78 /**
Chris@0 79 * Computes current style with stacks top codes.
Chris@0 80 *
Chris@0 81 * @return OutputFormatterStyle
Chris@0 82 */
Chris@0 83 public function getCurrent()
Chris@0 84 {
Chris@0 85 if (empty($this->styles)) {
Chris@0 86 return $this->emptyStyle;
Chris@0 87 }
Chris@0 88
Chris@17 89 return $this->styles[\count($this->styles) - 1];
Chris@0 90 }
Chris@0 91
Chris@0 92 /**
Chris@0 93 * @return $this
Chris@0 94 */
Chris@0 95 public function setEmptyStyle(OutputFormatterStyleInterface $emptyStyle)
Chris@0 96 {
Chris@0 97 $this->emptyStyle = $emptyStyle;
Chris@0 98
Chris@0 99 return $this;
Chris@0 100 }
Chris@0 101
Chris@0 102 /**
Chris@0 103 * @return OutputFormatterStyleInterface
Chris@0 104 */
Chris@0 105 public function getEmptyStyle()
Chris@0 106 {
Chris@0 107 return $this->emptyStyle;
Chris@0 108 }
Chris@0 109 }