interface OutputFormatterInterface in Zircon Profile 8

Formatter interface for console output.

@author Konstantin Kudryashov <[e-mail]>

Hierarchy

• interface \Symfony\Component\Console\Formatter\OutputFormatterInterface

7 files declare their use of OutputFormatterInterface

ConsoleOutput.php in vendor/symfony/console/Output/ConsoleOutput.php

Helper.php in vendor/symfony/console/Helper/Helper.php

NullOutput.php in vendor/symfony/console/Output/NullOutput.php

Output.php in vendor/symfony/console/Output/Output.php

OutputInterface.php in vendor/symfony/console/Output/OutputInterface.php

... See full list

File

vendor/symfony/console/Formatter/OutputFormatterInterface.php, line 19

Namespace

Symfony\Component\Console\Formatter

interface OutputFormatterInterface {

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

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

  /**
   * Sets a new style.
   *
   * @param string                        $name  The style name
   * @param OutputFormatterStyleInterface $style The style instance
   */
  public function setStyle($name, OutputFormatterStyleInterface $style);

  /**
   * Checks if output formatter has style with specified name.
   *
   * @param string $name
   *
   * @return bool
   */
  public function hasStyle($name);

  /**
   * Gets style options from style with specified name.
   *
   * @param string $name
   *
   * @return OutputFormatterStyleInterface
   */
  public function getStyle($name);

  /**
   * Formats a message according to the given styles.
   *
   * @param string $message The message to style
   *
   * @return string The styled message
   */
  public function format($message);

}

Members

Name	Modifiers	Type	Description	Overrides
OutputFormatterInterface::format	public	function	Formats a message according to the given styles.	1
OutputFormatterInterface::getStyle	public	function	Gets style options from style with specified name.	1
OutputFormatterInterface::hasStyle	public	function	Checks if output formatter has style with specified name.	1
OutputFormatterInterface::isDecorated	public	function	Gets the decorated flag.	1
OutputFormatterInterface::setDecorated	public	function	Sets the decorated flag.	1
OutputFormatterInterface::setStyle	public	function	Sets a new style.	1