vendor/symfony/console/Symfony/Component/Console/Formatter/OutputFormatterInterface.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 interface for console output.
  16  *
  17  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  18  *
  19  * @api
  20  */
  21 interface OutputFormatterInterface
  22 {
  23     /**
  24      * Sets the decorated flag.
  25      *
  26      * @param Boolean $decorated Whether to decorate the messages or not
  27      *
  28      * @api
  29      */
  30     public function setDecorated($decorated);
  31
  32     /**
  33      * Gets the decorated flag.
  34      *
  35      * @return Boolean true if the output will decorate messages, false otherwise
  36      *
  37      * @api
  38      */
  39     public function isDecorated();
  40
  41     /**
  42      * Sets a new style.
  43      *
  44      * @param string                        $name  The style name
  45      * @param OutputFormatterStyleInterface $style The style instance
  46      *
  47      * @api
  48      */
  49     public function setStyle($name, OutputFormatterStyleInterface $style);
  50
  51     /**
  52      * Checks if output formatter has style with specified name.
  53      *
  54      * @param string $name
  55      *
  56      * @return Boolean
  57      *
  58      * @api
  59      */
  60     public function hasStyle($name);
  61
  62     /**
  63      * Gets style options from style with specified name.
  64      *
  65      * @param string $name
  66      *
  67      * @return OutputFormatterStyleInterface
  68      *
  69      * @api
  70      */
  71     public function getStyle($name);
  72
  73     /**
  74      * Formats a message according to the given styles.
  75      *
  76      * @param string $message The message to style
  77      *
  78      * @return string The styled message
  79      *
  80      * @api
  81      */
  82     public function format($message);
  83 }