Интерфейс OutputFormatterInterface
интерфейс OutputFormatterInterface
Интерфейс форматирования для вывода в консоль.
Методы
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | ||
| bool | isDecorated() Возвращает флаг форматирования. | |
| setStyle(string $name, OutputFormatterStyleInterface $style) Устанавливает новый стиль. | ||
| bool | hasStyle(string $name) Проверяет, есть ли у форматера вывода стиль с указанным именем. | |
| OutputFormatterStyleInterface | getStyle(string $name) Возвращает параметры стиля с указанным именем. | |
| string | format(string $message) Форматирует сообщение в соответствии с заданными стилями. |
Подробности
setDecorated(bool $decorated)
Устанавливает флаг форматирования.
Параметры
| bool | $decorated | Выполнять ли форматирование сообщений |
bool isDecorated()
Возвращает флаг форматирования.
Возвращаемое значение
| bool | true, если вывод будет форматировать сообщения, иначе false |
setStyle(string $name, OutputFormatterStyleInterface $style)
Устанавливает новый стиль.
Параметры
| string | $name | Имя стиля |
| OutputFormatterStyleInterface | $style | Экземпляр стиля |
bool hasStyle(string $name)
Проверяет, есть ли у форматера вывода стиль с указанным именем.
Параметры
| string | $name |
Возвращаемое значение
| bool |
OutputFormatterStyleInterface getStyle(string $name)
Возвращает параметры стиля с указанным именем.
Параметры
| string | $name |
Возвращаемое значение
| OutputFormatterStyleInterface |
Исключения
| InvalidArgumentException | При отсутствии стиля |
string format(string $message)
Форматирует сообщение в соответствии с заданными стилями.
Параметры
| string | $message | Сообщение для форматирования |
Возвращаемое значение
| string | Отформатированное сообщение |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Console/Formatter/OutputFormatterInterface.html
