interface OutputInterface in Zircon Profile 8

OutputInterface is the interface implemented by all Output classes.

@author Fabien Potencier <[e-mail]>

Hierarchy

• interface \Symfony\Component\Console\Output\OutputInterface

48 files declare their use of OutputInterface

Application.php in vendor/symfony/console/Application.php

ApplicationTest.php in vendor/symfony/console/Tests/ApplicationTest.php

ApplicationTester.php in vendor/symfony/console/Tester/ApplicationTester.php

Command.php in vendor/symfony/console/Command/Command.php

CommandTest.php in vendor/symfony/console/Tests/Command/CommandTest.php

... See full list

File

vendor/symfony/console/Output/OutputInterface.php, line 21

Namespace

Symfony\Component\Console\Output

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 bool         $newline  Whether to add a newline
   * @param int          $type     The type of output (one of the OUTPUT constants)
   *
   * @throws \InvalidArgumentException When unknown output type is given
   */
  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 or a single string
   * @param int          $type     The type of output (one of the OUTPUT constants)
   *
   * @throws \InvalidArgumentException When unknown output type is given
   */
  public function writeln($messages, $type = self::OUTPUT_NORMAL);

  /**
   * Sets the verbosity of the output.
   *
   * @param int $level The level of verbosity (one of the VERBOSITY constants)
   */
  public function setVerbosity($level);

  /**
   * Gets the current verbosity of the output.
   *
   * @return int The current level of verbosity (one of the VERBOSITY constants)
   */
  public function getVerbosity();

  /**
   * Sets the decorated flag.
   *
   * @param bool $decorated Whether to decorate the messages
   */
  public function setDecorated($decorated);

  /**
   * Gets the decorated flag.
   *
   * @return bool true if the output will decorate messages, false otherwise
   */
  public function isDecorated();

  /**
   * Sets output formatter.
   *
   * @param OutputFormatterInterface $formatter
   */
  public function setFormatter(OutputFormatterInterface $formatter);

  /**
   * Returns current output formatter instance.
   *
   * @return OutputFormatterInterface
   */
  public function getFormatter();

}

Members

Name	Modifiers	Type	Description	Overrides
OutputInterface::getFormatter	public	function	Returns current output formatter instance.	3
OutputInterface::getVerbosity	public	function	Gets the current verbosity of the output.	3
OutputInterface::isDecorated	public	function	Gets the decorated flag.	3
OutputInterface::OUTPUT_NORMAL		constant
OutputInterface::OUTPUT_PLAIN		constant
OutputInterface::OUTPUT_RAW		constant
OutputInterface::setDecorated	public	function	Sets the decorated flag.	3
OutputInterface::setFormatter	public	function	Sets output formatter.	3
OutputInterface::setVerbosity	public	function	Sets the verbosity of the output.	3
OutputInterface::VERBOSITY_DEBUG		constant
OutputInterface::VERBOSITY_NORMAL		constant
OutputInterface::VERBOSITY_QUIET		constant
OutputInterface::VERBOSITY_VERBOSE		constant
OutputInterface::VERBOSITY_VERY_VERBOSE		constant
OutputInterface::write	public	function	Writes a message to the output.	3
OutputInterface::writeln	public	function	Writes a message to the output and adds a newline at the end.	3