annotate vendor/symfony/console/Style/OutputStyle.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\Style;
Chris@0 13
Chris@0 14 use Symfony\Component\Console\Formatter\OutputFormatterInterface;
Chris@0 15 use Symfony\Component\Console\Helper\ProgressBar;
Chris@17 16 use Symfony\Component\Console\Output\ConsoleOutputInterface;
Chris@0 17 use Symfony\Component\Console\Output\OutputInterface;
Chris@0 18
Chris@0 19 /**
Chris@0 20 * Decorates output to add console style guide helpers.
Chris@0 21 *
Chris@0 22 * @author Kevin Bond <kevinbond@gmail.com>
Chris@0 23 */
Chris@0 24 abstract class OutputStyle implements OutputInterface, StyleInterface
Chris@0 25 {
Chris@0 26 private $output;
Chris@0 27
Chris@0 28 public function __construct(OutputInterface $output)
Chris@0 29 {
Chris@0 30 $this->output = $output;
Chris@0 31 }
Chris@0 32
Chris@0 33 /**
Chris@0 34 * {@inheritdoc}
Chris@0 35 */
Chris@0 36 public function newLine($count = 1)
Chris@0 37 {
Chris@0 38 $this->output->write(str_repeat(PHP_EOL, $count));
Chris@0 39 }
Chris@0 40
Chris@0 41 /**
Chris@0 42 * @param int $max
Chris@0 43 *
Chris@0 44 * @return ProgressBar
Chris@0 45 */
Chris@0 46 public function createProgressBar($max = 0)
Chris@0 47 {
Chris@0 48 return new ProgressBar($this->output, $max);
Chris@0 49 }
Chris@0 50
Chris@0 51 /**
Chris@0 52 * {@inheritdoc}
Chris@0 53 */
Chris@0 54 public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL)
Chris@0 55 {
Chris@0 56 $this->output->write($messages, $newline, $type);
Chris@0 57 }
Chris@0 58
Chris@0 59 /**
Chris@0 60 * {@inheritdoc}
Chris@0 61 */
Chris@0 62 public function writeln($messages, $type = self::OUTPUT_NORMAL)
Chris@0 63 {
Chris@0 64 $this->output->writeln($messages, $type);
Chris@0 65 }
Chris@0 66
Chris@0 67 /**
Chris@0 68 * {@inheritdoc}
Chris@0 69 */
Chris@0 70 public function setVerbosity($level)
Chris@0 71 {
Chris@0 72 $this->output->setVerbosity($level);
Chris@0 73 }
Chris@0 74
Chris@0 75 /**
Chris@0 76 * {@inheritdoc}
Chris@0 77 */
Chris@0 78 public function getVerbosity()
Chris@0 79 {
Chris@0 80 return $this->output->getVerbosity();
Chris@0 81 }
Chris@0 82
Chris@0 83 /**
Chris@0 84 * {@inheritdoc}
Chris@0 85 */
Chris@0 86 public function setDecorated($decorated)
Chris@0 87 {
Chris@0 88 $this->output->setDecorated($decorated);
Chris@0 89 }
Chris@0 90
Chris@0 91 /**
Chris@0 92 * {@inheritdoc}
Chris@0 93 */
Chris@0 94 public function isDecorated()
Chris@0 95 {
Chris@0 96 return $this->output->isDecorated();
Chris@0 97 }
Chris@0 98
Chris@0 99 /**
Chris@0 100 * {@inheritdoc}
Chris@0 101 */
Chris@0 102 public function setFormatter(OutputFormatterInterface $formatter)
Chris@0 103 {
Chris@0 104 $this->output->setFormatter($formatter);
Chris@0 105 }
Chris@0 106
Chris@0 107 /**
Chris@0 108 * {@inheritdoc}
Chris@0 109 */
Chris@0 110 public function getFormatter()
Chris@0 111 {
Chris@0 112 return $this->output->getFormatter();
Chris@0 113 }
Chris@0 114
Chris@0 115 /**
Chris@0 116 * {@inheritdoc}
Chris@0 117 */
Chris@0 118 public function isQuiet()
Chris@0 119 {
Chris@0 120 return $this->output->isQuiet();
Chris@0 121 }
Chris@0 122
Chris@0 123 /**
Chris@0 124 * {@inheritdoc}
Chris@0 125 */
Chris@0 126 public function isVerbose()
Chris@0 127 {
Chris@0 128 return $this->output->isVerbose();
Chris@0 129 }
Chris@0 130
Chris@0 131 /**
Chris@0 132 * {@inheritdoc}
Chris@0 133 */
Chris@0 134 public function isVeryVerbose()
Chris@0 135 {
Chris@0 136 return $this->output->isVeryVerbose();
Chris@0 137 }
Chris@0 138
Chris@0 139 /**
Chris@0 140 * {@inheritdoc}
Chris@0 141 */
Chris@0 142 public function isDebug()
Chris@0 143 {
Chris@0 144 return $this->output->isDebug();
Chris@0 145 }
Chris@14 146
Chris@14 147 protected function getErrorOutput()
Chris@14 148 {
Chris@14 149 if (!$this->output instanceof ConsoleOutputInterface) {
Chris@14 150 return $this->output;
Chris@14 151 }
Chris@14 152
Chris@14 153 return $this->output->getErrorOutput();
Chris@14 154 }
Chris@0 155 }