OutputFormatterStyleInterface.php in Zircon Profile 8

Namespace

Symfony\Component\Console\Formatter

File

vendor/symfony/console/Formatter/OutputFormatterStyleInterface.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 style interface for defining styles.
 *
 * @author Konstantin Kudryashov <[e-mail]>
 */
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);

}

Interfaces

Name	Description
OutputFormatterStyleInterface	Formatter style interface for defining styles.