You are here

interface OutputFormatterStyleInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/symfony/console/Formatter/OutputFormatterStyleInterface.php \Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

Formatter style interface for defining styles.

@author Konstantin Kudryashov <ever.zet@gmail.com>

Hierarchy

Expanded class hierarchy of OutputFormatterStyleInterface

All classes that implement OutputFormatterStyleInterface

File

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

Namespace

Symfony\Component\Console\Formatter
View source
interface OutputFormatterStyleInterface {

  /**
   * Sets style foreground color.
   *
   * @param string $color The color name
   */
  public function setForeground($color = null);

  /**
   * Sets style background color.
   *
   * @param string $color The color name
   */
  public function setBackground($color = null);

  /**
   * Sets some specific style option.
   *
   * @param string $option The option name
   */
  public function setOption($option);

  /**
   * Unsets some specific style option.
   *
   * @param string $option The option name
   */
  public function unsetOption($option);

  /**
   * Sets multiple style options at once.
   *
   * @param array $options
   */
  public function setOptions(array $options);

  /**
   * Applies the style to a given text.
   *
   * @param string $text The text to style
   *
   * @return string
   */
  public function apply($text);

}

Members

Namesort descending Modifiers Type Description Overrides
OutputFormatterStyleInterface::apply public function Applies the style to a given text. 1
OutputFormatterStyleInterface::setBackground public function Sets style background color. 1
OutputFormatterStyleInterface::setForeground public function Sets style foreground color. 1
OutputFormatterStyleInterface::setOption public function Sets some specific style option. 1
OutputFormatterStyleInterface::setOptions public function Sets multiple style options at once. 1
OutputFormatterStyleInterface::unsetOption public function Unsets some specific style option. 1