[Summary view] [Print] [Text view]

   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 = 0;
  24      const VERBOSITY_NORMAL = 1;
  25      const VERBOSITY_VERBOSE = 2;
  26      const VERBOSITY_VERY_VERBOSE = 3;
  27      const VERBOSITY_DEBUG = 4;
  28  
  29      const OUTPUT_NORMAL = 0;
  30      const OUTPUT_RAW = 1;
  31      const OUTPUT_PLAIN = 2;
  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          $type     The type of output (one of the OUTPUT constants)
  39       *
  40       * @throws \InvalidArgumentException When unknown output type is given
  41       */
  42      public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL);
  43  
  44      /**
  45       * Writes a message to the output and adds a newline at the end.
  46       *
  47       * @param string|array $messages The message as an array of lines or a single string
  48       * @param int          $type     The type of output (one of the OUTPUT constants)
  49       *
  50       * @throws \InvalidArgumentException When unknown output type is given
  51       */
  52      public function writeln($messages, $type = self::OUTPUT_NORMAL);
  53  
  54      /**
  55       * Sets the verbosity of the output.
  56       *
  57       * @param int $level The level of verbosity (one of the VERBOSITY constants)
  58       */
  59      public function setVerbosity($level);
  60  
  61      /**
  62       * Gets the current verbosity of the output.
  63       *
  64       * @return int The current level of verbosity (one of the VERBOSITY constants)
  65       */
  66      public function getVerbosity();
  67  
  68      /**
  69       * Sets the decorated flag.
  70       *
  71       * @param bool $decorated Whether to decorate the messages
  72       */
  73      public function setDecorated($decorated);
  74  
  75      /**
  76       * Gets the decorated flag.
  77       *
  78       * @return bool true if the output will decorate messages, false otherwise
  79       */
  80      public function isDecorated();
  81  
  82      /**
  83       * Sets output formatter.
  84       *
  85       * @param OutputFormatterInterface $formatter
  86       */
  87      public function setFormatter(OutputFormatterInterface $formatter);
  88  
  89      /**
  90       * Returns current output formatter instance.
  91       *
  92       * @return OutputFormatterInterface
  93       */
  94      public function getFormatter();
  95  }