vendor/symfony/console/Symfony/Component/Console/Formatter/OutputFormatterStyleInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Console\Formatter;
  13
  14 /**
  15  * Formatter style interface for defining styles.
  16  *
  17  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  18  *
  19  * @api
  20  */
  21 interface OutputFormatterStyleInterface
  22 {
  23     /**
  24      * Sets style foreground color.
  25      *
  26      * @param string $color The color name
  27      *
  28      * @api
  29      */
  30     public function setForeground($color = null);
  31
  32     /**
  33      * Sets style background color.
  34      *
  35      * @param string $color The color name
  36      *
  37      * @api
  38      */
  39     public function setBackground($color = null);
  40
  41     /**
  42      * Sets some specific style option.
  43      *
  44      * @param string $option The option name
  45      *
  46      * @api
  47      */
  48     public function setOption($option);
  49
  50     /**
  51      * Unsets some specific style option.
  52      *
  53      * @param string $option The option name
  54      */
  55     public function unsetOption($option);
  56
  57     /**
  58      * Sets multiple style options at once.
  59      *
  60      * @param array $options
  61      */
  62     public function setOptions(array $options);
  63
  64     /**
  65      * Applies the style to a given text.
  66      *
  67      * @param string $text The text to style
  68      *
  69      * @return string
  70      */
  71     public function apply($text);
  72 }