Blame view

sources/3rdparty/symfony/console/Symfony/Component/Console/Output/OutputInterface.php 2.83 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
  <?php
  
  /*
   * This file is part of the Symfony package.
   *
   * (c) Fabien Potencier <fabien@symfony.com>
   *
   * For the full copyright and license information, please view the LICENSE
   * file that was distributed with this source code.
   */
  
  namespace Symfony\Component\Console\Output;
  
  use Symfony\Component\Console\Formatter\OutputFormatterInterface;
  
  /**
   * OutputInterface is the interface implemented by all Output classes.
   *
   * @author Fabien Potencier <fabien@symfony.com>
   *
   * @api
   */
  interface OutputInterface
  {
      const VERBOSITY_QUIET        = 0;
      const VERBOSITY_NORMAL       = 1;
      const VERBOSITY_VERBOSE      = 2;
      const VERBOSITY_VERY_VERBOSE = 3;
      const VERBOSITY_DEBUG        = 4;
  
      const OUTPUT_NORMAL = 0;
      const OUTPUT_RAW    = 1;
      const OUTPUT_PLAIN  = 2;
  
      /**
       * Writes a message to the output.
       *
       * @param string|array $messages The message as an array of lines or a single string
       * @param Boolean      $newline  Whether to add a newline
       * @param integer      $type     The type of output (one of the OUTPUT constants)
       *
       * @throws \InvalidArgumentException When unknown output type is given
       *
       * @api
       */
      public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL);
  
      /**
       * Writes a message to the output and adds a newline at the end.
       *
       * @param string|array $messages The message as an array of lines of a single string
       * @param integer      $type     The type of output (one of the OUTPUT constants)
       *
       * @throws \InvalidArgumentException When unknown output type is given
       *
       * @api
       */
      public function writeln($messages, $type = self::OUTPUT_NORMAL);
  
      /**
       * Sets the verbosity of the output.
       *
       * @param integer $level The level of verbosity (one of the VERBOSITY constants)
       *
       * @api
       */
      public function setVerbosity($level);
  
      /**
       * Gets the current verbosity of the output.
       *
       * @return integer The current level of verbosity (one of the VERBOSITY constants)
       *
       * @api
       */
      public function getVerbosity();
  
      /**
       * Sets the decorated flag.
       *
       * @param Boolean $decorated Whether to decorate the messages
       *
       * @api
       */
      public function setDecorated($decorated);
  
      /**
       * Gets the decorated flag.
       *
       * @return Boolean true if the output will decorate messages, false otherwise
       *
       * @api
       */
      public function isDecorated();
  
      /**
       * Sets output formatter.
       *
       * @param OutputFormatterInterface $formatter
       *
       * @api
       */
      public function setFormatter(OutputFormatterInterface $formatter);
  
      /**
       * Returns current output formatter instance.
       *
       * @return  OutputFormatterInterface
       *
       * @api
       */
      public function getFormatter();
  }