You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
71 lines
1.7 KiB
71 lines
1.7 KiB
<?php |
|
|
|
/* |
|
* This file is part of the Symfony package. |
|
* |
|
* (c) Fabien Potencier <fabien@symfony.com> |
|
* |
|
* 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 interface for console output. |
|
* |
|
* @author Konstantin Kudryashov <ever.zet@gmail.com> |
|
*/ |
|
interface OutputFormatterInterface |
|
{ |
|
/** |
|
* Sets the decorated flag. |
|
* |
|
* @param bool $decorated Whether to decorate the messages or not |
|
*/ |
|
public function setDecorated($decorated); |
|
|
|
/** |
|
* Gets the decorated flag. |
|
* |
|
* @return bool true if the output will decorate messages, false otherwise |
|
*/ |
|
public function isDecorated(); |
|
|
|
/** |
|
* Sets a new style. |
|
* |
|
* @param string $name The style name |
|
* @param OutputFormatterStyleInterface $style The style instance |
|
*/ |
|
public function setStyle($name, OutputFormatterStyleInterface $style); |
|
|
|
/** |
|
* Checks if output formatter has style with specified name. |
|
* |
|
* @param string $name |
|
* |
|
* @return bool |
|
*/ |
|
public function hasStyle($name); |
|
|
|
/** |
|
* Gets style options from style with specified name. |
|
* |
|
* @param string $name |
|
* |
|
* @return OutputFormatterStyleInterface |
|
* |
|
* @throws \InvalidArgumentException When style isn't defined |
|
*/ |
|
public function getStyle($name); |
|
|
|
/** |
|
* Formats a message according to the given styles. |
|
* |
|
* @param string $message The message to style |
|
* |
|
* @return string The styled message |
|
*/ |
|
public function format($message); |
|
}
|
|
|