ФорматировщикВывода
класс ФорматировщикВывода реализует 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/2.7/Symfony/Component/Console/Formatter/OutputFormatter.html