[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <[email protected]>
   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 <[email protected]>
  20   */
  21  interface OutputInterface
  22  {
  23      public const VERBOSITY_QUIET = 16;
  24      public const VERBOSITY_NORMAL = 32;
  25      public const VERBOSITY_VERBOSE = 64;
  26      public const VERBOSITY_VERY_VERBOSE = 128;
  27      public const VERBOSITY_DEBUG = 256;
  28  
  29      public const OUTPUT_NORMAL = 1;
  30      public const OUTPUT_RAW = 2;
  31      public const OUTPUT_PLAIN = 4;
  32  
  33      /**
  34       * Writes a message to the output.
  35       *
  36       * @param string|iterable $messages The message as an iterable of strings 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, bool $newline = false, int $options = 0);
  41  
  42      /**
  43       * Writes a message to the output and adds a newline at the end.
  44       *
  45       * @param string|iterable $messages The message as an iterable of strings or 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, int $options = 0);
  49  
  50      /**
  51       * Sets the verbosity of the output.
  52       */
  53      public function setVerbosity(int $level);
  54  
  55      /**
  56       * Gets the current verbosity of the output.
  57       *
  58       * @return int
  59       */
  60      public function getVerbosity();
  61  
  62      /**
  63       * Returns whether verbosity is quiet (-q).
  64       *
  65       * @return bool
  66       */
  67      public function isQuiet();
  68  
  69      /**
  70       * Returns whether verbosity is verbose (-v).
  71       *
  72       * @return bool
  73       */
  74      public function isVerbose();
  75  
  76      /**
  77       * Returns whether verbosity is very verbose (-vv).
  78       *
  79       * @return bool
  80       */
  81      public function isVeryVerbose();
  82  
  83      /**
  84       * Returns whether verbosity is debug (-vvv).
  85       *
  86       * @return bool
  87       */
  88      public function isDebug();
  89  
  90      /**
  91       * Sets the decorated flag.
  92       */
  93      public function setDecorated(bool $decorated);
  94  
  95      /**
  96       * Gets the decorated flag.
  97       *
  98       * @return bool
  99       */
 100      public function isDecorated();
 101  
 102      public function setFormatter(OutputFormatterInterface $formatter);
 103  
 104      /**
 105       * Returns current output formatter instance.
 106       *
 107       * @return OutputFormatterInterface
 108       */
 109      public function getFormatter();
 110  }