[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <[email protected]>
   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 <[email protected]>
  18   */
  19  interface OutputFormatterStyleInterface
  20  {
  21      /**
  22       * Sets style foreground color.
  23       */
  24      public function setForeground(string $color = null);
  25  
  26      /**
  27       * Sets style background color.
  28       */
  29      public function setBackground(string $color = null);
  30  
  31      /**
  32       * Sets some specific style option.
  33       */
  34      public function setOption(string $option);
  35  
  36      /**
  37       * Unsets some specific style option.
  38       */
  39      public function unsetOption(string $option);
  40  
  41      /**
  42       * Sets multiple style options at once.
  43       */
  44      public function setOptions(array $options);
  45  
  46      /**
  47       * Applies the style to a given text.
  48       *
  49       * @return string
  50       */
  51      public function apply(string $text);
  52  }