ФорматировщикВывода
класс ФорматировщикВывода реализует OutputFormatterInterface
Класс-форматировщик для вывода в консоли.
Методы
| статический string | escape(string $text) Экранирует специальный символ "<" в заданном тексте. | |
| статический string | escapeTrailingBackslash(string $text) Экранирует заключительную "\" в заданном тексте. | |
| __construct(bool $decorated = false, array $styles = array()) Инициализирует форматировщик вывода в консоли. | ||
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | ||
| bool | isDecorated() Получает флаг форматирования. | |
| setStyle(string $name, OutputFormatterStyleInterface $style) Устанавливает новый стиль. | ||
| bool | hasStyle(string $name) Проверяет наличие у форматировщика стиля с указанным именем. | |
| OutputFormatterStyleInterface | getStyle(string $name) Получает параметры стиля по указанному имени. | |
| string | format(string $message) Форматирует сообщение в соответствии с заданными стилями. | |
| OutputFormatterStyleStack | getStyleStack() |
Подробности
статический string escape(string $text)
Экранирует специальный символ "<" в заданном тексте.
Параметры
| string | $text | Текст для экранирования |
Значение возврата
| string | Экранированный текст |
статический string escapeTrailingBackslash(string $text)
Экранирует заключительную "\" в заданном тексте.
Параметры
| string | $text | Текст для экранирования |
Значение возврата
| string | Экранированный текст |
__construct(bool $decorated = false, array $styles = array())
Инициализирует форматировщик вывода в консоли.
Параметры
| bool | $decorated | Необходимо ли форматировать строки |
| array | $styles | Массив экземпляров "имя => FormatterStyle" |
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 | Отформатированное сообщение |
OutputFormatterStyleStack getStyleStack()
Значение возврата
| OutputFormatterStyleStack |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Console/Formatter/OutputFormatter.html