OutputInterface.php in Zircon Profile 8

Namespace

Symfony\Component\Console\Output

File

vendor/symfony/console/Output/OutputInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * 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 <[e-mail]>
 */
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();

}

Interfaces

Name	Description
OutputInterface	OutputInterface is the interface implemented by all Output classes.