comparison vendor/symfony/console/Output/OutputInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 1fec387a4317
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\Output;
13
14 use Symfony\Component\Console\Formatter\OutputFormatterInterface;
15
16 /**
17 * OutputInterface is the interface implemented by all Output classes.
18 *
19 * @author Fabien Potencier <fabien@symfony.com>
20 */
21 interface OutputInterface
22 {
23 const VERBOSITY_QUIET = 16;
24 const VERBOSITY_NORMAL = 32;
25 const VERBOSITY_VERBOSE = 64;
26 const VERBOSITY_VERY_VERBOSE = 128;
27 const VERBOSITY_DEBUG = 256;
28
29 const OUTPUT_NORMAL = 1;
30 const OUTPUT_RAW = 2;
31 const OUTPUT_PLAIN = 4;
32
33 /**
34 * Writes a message to the output.
35 *
36 * @param string|array $messages The message as an array of lines or a single string
37 * @param bool $newline Whether to add a newline
38 * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
39 */
40 public function write($messages, $newline = false, $options = 0);
41
42 /**
43 * Writes a message to the output and adds a newline at the end.
44 *
45 * @param string|array $messages The message as an array of lines of a single string
46 * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
47 */
48 public function writeln($messages, $options = 0);
49
50 /**
51 * Sets the verbosity of the output.
52 *
53 * @param int $level The level of verbosity (one of the VERBOSITY constants)
54 */
55 public function setVerbosity($level);
56
57 /**
58 * Gets the current verbosity of the output.
59 *
60 * @return int The current level of verbosity (one of the VERBOSITY constants)
61 */
62 public function getVerbosity();
63
64 /**
65 * Returns whether verbosity is quiet (-q).
66 *
67 * @return bool true if verbosity is set to VERBOSITY_QUIET, false otherwise
68 */
69 public function isQuiet();
70
71 /**
72 * Returns whether verbosity is verbose (-v).
73 *
74 * @return bool true if verbosity is set to VERBOSITY_VERBOSE, false otherwise
75 */
76 public function isVerbose();
77
78 /**
79 * Returns whether verbosity is very verbose (-vv).
80 *
81 * @return bool true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise
82 */
83 public function isVeryVerbose();
84
85 /**
86 * Returns whether verbosity is debug (-vvv).
87 *
88 * @return bool true if verbosity is set to VERBOSITY_DEBUG, false otherwise
89 */
90 public function isDebug();
91
92 /**
93 * Sets the decorated flag.
94 *
95 * @param bool $decorated Whether to decorate the messages
96 */
97 public function setDecorated($decorated);
98
99 /**
100 * Gets the decorated flag.
101 *
102 * @return bool true if the output will decorate messages, false otherwise
103 */
104 public function isDecorated();
105
106 /**
107 * Sets output formatter.
108 *
109 * @param OutputFormatterInterface $formatter
110 */
111 public function setFormatter(OutputFormatterInterface $formatter);
112
113 /**
114 * Returns current output formatter instance.
115 *
116 * @return OutputFormatterInterface
117 */
118 public function getFormatter();
119 }