Mercurial > hg > isophonics-drupal-site
comparison vendor/symfony/console/Formatter/OutputFormatterInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:4c8ae668cc8c |
---|---|
1 <?php | |
2 | |
3 /* | |
4 * This file is part of the Symfony package. | |
5 * | |
6 * (c) Fabien Potencier <fabien@symfony.com> | |
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 interface for console output. | |
16 * | |
17 * @author Konstantin Kudryashov <ever.zet@gmail.com> | |
18 */ | |
19 interface OutputFormatterInterface | |
20 { | |
21 /** | |
22 * Sets the decorated flag. | |
23 * | |
24 * @param bool $decorated Whether to decorate the messages or not | |
25 */ | |
26 public function setDecorated($decorated); | |
27 | |
28 /** | |
29 * Gets the decorated flag. | |
30 * | |
31 * @return bool true if the output will decorate messages, false otherwise | |
32 */ | |
33 public function isDecorated(); | |
34 | |
35 /** | |
36 * Sets a new style. | |
37 * | |
38 * @param string $name The style name | |
39 * @param OutputFormatterStyleInterface $style The style instance | |
40 */ | |
41 public function setStyle($name, OutputFormatterStyleInterface $style); | |
42 | |
43 /** | |
44 * Checks if output formatter has style with specified name. | |
45 * | |
46 * @param string $name | |
47 * | |
48 * @return bool | |
49 */ | |
50 public function hasStyle($name); | |
51 | |
52 /** | |
53 * Gets style options from style with specified name. | |
54 * | |
55 * @param string $name | |
56 * | |
57 * @return OutputFormatterStyleInterface | |
58 * | |
59 * @throws \InvalidArgumentException When style isn't defined | |
60 */ | |
61 public function getStyle($name); | |
62 | |
63 /** | |
64 * Formats a message according to the given styles. | |
65 * | |
66 * @param string $message The message to style | |
67 * | |
68 * @return string The styled message | |
69 */ | |
70 public function format($message); | |
71 } |