[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 interface for console output.
  16   *
  17   * @author Konstantin Kudryashov <[email protected]>
  18   */
  19  interface OutputFormatterInterface
  20  {
  21      /**
  22       * Sets the decorated flag.
  23       */
  24      public function setDecorated(bool $decorated);
  25  
  26      /**
  27       * Whether the output will decorate messages.
  28       *
  29       * @return bool
  30       */
  31      public function isDecorated();
  32  
  33      /**
  34       * Sets a new style.
  35       */
  36      public function setStyle(string $name, OutputFormatterStyleInterface $style);
  37  
  38      /**
  39       * Checks if output formatter has style with specified name.
  40       *
  41       * @return bool
  42       */
  43      public function hasStyle(string $name);
  44  
  45      /**
  46       * Gets style options from style with specified name.
  47       *
  48       * @return OutputFormatterStyleInterface
  49       *
  50       * @throws \InvalidArgumentException When style isn't defined
  51       */
  52      public function getStyle(string $name);
  53  
  54      /**
  55       * Formats a message according to the given styles.
  56       *
  57       * @return string|null
  58       */
  59      public function format(?string $message);
  60  }