ФорматировщикВывода
класс OutputFormatter реализует 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() |
Подробности
static string escape(string $text)
Экранирует спецсимвол "<" в заданном тексте.
Параметры
| string | $text | Текст для экранирования |
Возвращаемое значение
| string | Экранированный текст |
static string escapeTrailingBackslash(string $text)
Экранирует заключительную "\" в заданном тексте.
Параметры
| string | $text | Текст для экранирования |
Возвращаемое значение
| string | Экранированный текст |
__construct(bool $decorated = false, array $styles = array())
Инициализирует форматер вывода консоли.
Параметры
| bool | $decorated | Указывает, нужно ли форматировать строки |
| array | $styles | Массив экземпляров "name => 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.1/Symfony/Component/Console/Formatter/OutputFormatter.html