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

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
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 /**
Chris@0 15 * Formatter interface for console output.
Chris@0 16 *
Chris@0 17 * @author Konstantin Kudryashov <ever.zet@gmail.com>
Chris@0 18 */
Chris@0 19 interface OutputFormatterInterface
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * Sets the decorated flag.
Chris@0 23 *
Chris@0 24 * @param bool $decorated Whether to decorate the messages or not
Chris@0 25 */
Chris@0 26 public function setDecorated($decorated);
Chris@0 27
Chris@0 28 /**
Chris@0 29 * Gets the decorated flag.
Chris@0 30 *
Chris@0 31 * @return bool true if the output will decorate messages, false otherwise
Chris@0 32 */
Chris@0 33 public function isDecorated();
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Sets a new style.
Chris@0 37 *
Chris@0 38 * @param string $name The style name
Chris@0 39 * @param OutputFormatterStyleInterface $style The style instance
Chris@0 40 */
Chris@0 41 public function setStyle($name, OutputFormatterStyleInterface $style);
Chris@0 42
Chris@0 43 /**
Chris@0 44 * Checks if output formatter has style with specified name.
Chris@0 45 *
Chris@0 46 * @param string $name
Chris@0 47 *
Chris@0 48 * @return bool
Chris@0 49 */
Chris@0 50 public function hasStyle($name);
Chris@0 51
Chris@0 52 /**
Chris@0 53 * Gets style options from style with specified name.
Chris@0 54 *
Chris@0 55 * @param string $name
Chris@0 56 *
Chris@0 57 * @return OutputFormatterStyleInterface
Chris@0 58 *
Chris@0 59 * @throws \InvalidArgumentException When style isn't defined
Chris@0 60 */
Chris@0 61 public function getStyle($name);
Chris@0 62
Chris@0 63 /**
Chris@0 64 * Formats a message according to the given styles.
Chris@0 65 *
Chris@0 66 * @param string $message The message to style
Chris@0 67 *
Chris@0 68 * @return string The styled message
Chris@0 69 */
Chris@0 70 public function format($message);
Chris@0 71 }