ConsoleSectionOutput
class ConsoleSectionOutput extends StreamOutput
Методы
| __construct(resource $stream, array $sections, int|null $verbosity, bool $decorated, OutputFormatterInterface $formatter) | ||
| setFormatter(OutputFormatterInterface $formatter) | from Output | |
| OutputFormatterInterface | getFormatter() Возвращает текущий экземпляр форматировщика вывода. | from Output |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | from Output | |
| bool | isDecorated() Возвращает флаг форматирования. | from Output |
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | from Output | |
| int | getVerbosity() Возвращает текущий уровень подробности вывода. | from Output |
| bool | isQuiet() Возвращает true, если уровень подробности вывода – «тихий» (-q). | from Output |
| bool | isVerbose() Возвращает true, если уровень подробности вывода – «подробный» (-v). | from Output |
| bool | isVeryVerbose() Возвращает true, если уровень подробности вывода – «очень подробный» (-vv). | from Output |
| bool | isDebug() Возвращает true, если уровень подробности вывода – «отладочный» (-vvv). | from Output |
| writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL) Выводит сообщение на вывод и добавляет перевод строки в конце. | from Output | |
| write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL) Выводит сообщение на вывод. | from Output | |
| doWrite(string $message, bool $newline) Выводит сообщение на вывод. | ||
| resource | getStream() Возвращает поток, присоединенный к этому экземпляру StreamOutput. | from StreamOutput |
| bool | hasColorSupport() Возвращает true, если поток поддерживает форматирование цветом. | from StreamOutput |
| clear(int $lines = null) Очищает предыдущий вывод для данного раздела. | ||
| overwrite(array|string $message) Перезаписывает предыдущий вывод новым сообщением. | ||
| string | getContent() | |
| addContent(string $input) |
Подробности
__construct(resource $stream, array $sections, int|null $verbosity, bool $decorated, OutputFormatterInterface $formatter)
Параметры
| resource | $stream | Поток ресурсов |
| array | $sections | |
| int|null | $verbosity | Уровень подробности (один из констант VERBOSITY в OutputInterface) |
| bool | $decorated | Нужно ли форматировать сообщения |
| OutputFormatterInterface | $formatter | Экземпляр форматировщика вывода (null для использования по умолчанию OutputFormatter) |
setFormatter(OutputFormatterInterface $formatter)
Параметры
| OutputFormatterInterface | $formatter |
OutputFormatterInterface getFormatter()
Возвращает текущий экземпляр форматировщика вывода.
Значение возврата
| OutputFormatterInterface |
setDecorated(bool $decorated)
Устанавливает флаг форматирования.
Параметры
| bool | $decorated | Нужно ли форматировать сообщения |
bool isDecorated()
Возвращает флаг форматирования.
Значение возврата
| bool | true, если вывод будет форматирован, иначе false |
setVerbosity(int $level)
Устанавливает уровень подробности вывода.
Параметры
| int | $level | Уровень подробности (одна из констант VERBOSITY) |
int getVerbosity()
Возвращает текущий уровень подробности вывода.
Значение возврата
| int | Текущий уровень подробности (одна из констант VERBOSITY) |
bool isQuiet()
Возвращает значение, указывает ли уровень подробности на тихий режим (-q).
Значение возврата
| bool | true, если уровень подробности установлен в VERBOSITY_QUIET, иначе false |
bool isVerbose()
Возвращает значение, указывает ли уровень подробности на подробный режим (-v).
Значение возврата
| bool | true, если уровень подробности установлен в VERBOSITY_VERBOSE, иначе false |
bool isVeryVerbose()
Возвращает значение, указывает ли уровень подробности на очень подробный режим (-vv).
Значение возврата
| bool | true, если уровень подробности установлен в VERBOSITY_VERY_VERBOSE, иначе false |
bool isDebug()
Возвращает значение, указывает ли уровень подробности на отладочный режим (-vvv).
Значение возврата
| bool | true, если уровень подробности установлен в VERBOSITY_DEBUG, иначе false |
writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL)
Выводит сообщение в вывод и добавляет перевод строки в конце.
Параметры
| string|iterable | $messages | Сообщение как итерируемый объект строк или одиночная строка |
| int | $options | Побитовая маска опций (одна из констант OUTPUT или VERBOSITY), 0 рассматривается как эквивалент self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL)
Выводит сообщение в вывод.
Параметры
| string|iterable | $messages | Сообщение как итерируемый объект строк или одиночная строка |
| bool | $newline | Добавлять ли перевод строки |
| int | $options | Побитовая маска опций (одна из констант OUTPUT или VERBOSITY), 0 рассматривается как эквивалент self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
protected doWrite(string $message, bool $newline)
Выводит сообщение в вывод.
Параметры
| string | $message | Сообщение для вывода |
| bool | $newline | Добавлять ли перевод строки |
resource getStream()
Возвращает поток, присоединенный к этому экземпляру StreamOutput.
Значение возврата
| resource | Поток ресурсов |
protected bool hasColorSupport()
Возвращает true, если поток поддерживает цвет.
Цвет отключен, если он не поддерживается потоком:
Это сложно на Windows, потому что Cygwin, Msys2 и т. д. эмулируют псевдотерминалы через именованные каналы, поэтому мы можем проверить только среду.
Ссылка: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler
Значение возврата
| bool | true, если поток поддерживает цвет, иначе false |
clear(int $lines = null)
Очищает предыдущий вывод для этого раздела.
Параметры
| int | $lines | Количество строк для очистки. Если null, то очищается весь вывод этого раздела |
overwrite(array|string $message)
Перезаписывает предыдущий вывод новым сообщением.
Параметры
| array|string | $message |
string getContent()
Значение возврата
| string |
addContent(string $input)
Параметры
| string | $input |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Output/ConsoleSectionOutput.html