OutputFormatterInterface.php in Zircon Profile 8

Namespace

Symfony\Component\Console\Formatter

File

vendor/symfony/console/Formatter/OutputFormatterInterface.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\Formatter;


/**
 * Formatter interface for console output.
 *
 * @author Konstantin Kudryashov <[e-mail]>
 */
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);

}

Interfaces

Name	Description
OutputFormatterInterface	Formatter interface for console output.