Класс ConsoleOutput

Обёртка для вывода информации из приложения оболочки. Может быть подключена к любому ресурсу потока, который может использоваться с fopen()

Может генерировать вывод с цветовой индикацией на консолях, которые её поддерживают. Есть несколько встроенных стилей

error Сообщения об ошибках.
warning Предупреждающие сообщения.
info Информационные сообщения.
comment Дополнительный текст.
question Фиолетовый текст, используемый для приглашений пользователя

Определяя стили с помощью addStyle(), вы можете создавать пользовательские стили консоли.

Использование стилей в выводе

Вы можете форматировать вывод консоли, используя теги с именем применяемого стиля. Изнутри объекта оболочки

$this->out('<warning>Overwrite:</warning> foo.php was overwritten.');

Это создаст оранжевый текст 'Overwrite:', а остальной текст сохранит свой обычный цвет. См. ConsoleOutput::styles(), чтобы узнать больше о определении собственных стилей. Вложенные стили в настоящее время не поддерживаются.

Пространство имён: Cake\Console

Постоянные значения

int

COLOR
```
2
```
Цветной вывод - Преобразовывает известные теги в ANSI коды цветовых последовательностей.
string

LF
```
PHP_EOL
```
Постоянная для новой строки.
int

PLAIN
```
1
```
Обычный вывод - теги будут удалены.
int

RAW
```
0
```
Постоянная для сырого вывода - никакой модификации текста вывода.

Резюме свойств

$_backgroundColors protected static

array

цвета фона, используемые в цветном выводе.
$_foregroundColors protected static

array

цвета текста, используемые в цветном выводе.
$_options protected static

array

Параметры форматирования для цветного вывода.
$_output protected

resource

Дескриптор файла для вывода.
$_outputAs protected

int

Текущий тип вывода.
$_styles protected static

array

Стили, доступные в виде тегов в выводе консоли. Вы можете изменить эти стили с помощью ConsoleOutput::styles()

Краткое описание методов

__construct()public
Создать объект вывода.
__destruct()public
Очистка и закрытие дескрипторов.
_replaceTags()protected
Замена тегов на цветовые коды.
_write()protected
Запись сообщения в поток вывода.
getOutputAs()public
Получить тип вывода для обработки тегов форматирования.
getStyle()public
Получить текущие доступные стили.
setOutputAs()public
Установить тип вывода для обработки тегов форматирования.
setStyle()public
Установить стиль.
styleText()public
Применить стили к тексту.
styles()public
Получить все определения стилей.
write()public
Выводит одно или несколько сообщений в стандартный вывод или стандартный поток ошибок. Если параметры не переданы, выводит только новую строку.

Подробное описание методов

public__construct()

Создать объект вывода.

Проверяет наличие среды отображения с красивым видом. Ansicon и ConEmu поддерживают красивую консоль на Windows.

Параметры

$streamoptional: Идентификатор потока для записи вывода.

public__destruct()

Очистка и закрытие дескрипторов

protected_replaceTags()

Замена тегов на цветовые коды.

Параметры

$matches: Массив совпадений для замены.

protected_write()

Запись сообщения в поток вывода.

Параметры

$message: Сообщение для записи.

publicgetOutputAs()

Получить тип вывода для обработки тегов форматирования.

publicgetStyle()

Получить текущие доступные стили.

publicsetOutputAs()

Установить тип вывода для обработки тегов форматирования.

publicsetStyle()

Установить стиль.

Создание или модификация существующего стиля.

Удаление стиля

publicstyleText()

Применить стили к тексту.

publicstyles()

Получить все определения стилей.

publicwrite()

Выводит одно или несколько сообщений в стандартный вывод или стандартный поток ошибок. Если параметры не переданы, выводит только новую строку.

Параметры

$message: Строка или массив строк для вывода.
$newlinesoptional: Количество добавляемых новых строк.

Подробное описание свойств

`$_backgroundColors`protectedstatic

Цвета фона, используемые в цветном выводе.

`$_foregroundColors`protectedstatic

Цвета текста, используемые в цветном выводе.

`$_options`protectedstatic

Параметры форматирования для цветного вывода.

`$_output`protected

Дескриптор файла для вывода.

`$_outputAs`protected

Текущий тип вывода.

`$_styles`protectedstatic

Стили, доступные как теги в выводе консоли. Вы можете изменить эти стили с помощью ConsoleOutput::styles()

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Console.ConsoleOutput.html

Класс ConsoleOutput

Использование стилей в выводе

Постоянные значения

Резюме свойств

Краткое описание методов

__construct()public

__destruct()public

_replaceTags()protected

_write()protected

getOutputAs()public

getStyle()public

setOutputAs()public

setStyle()public

styleText()public

styles()public

write()public

Подробное описание методов

public__construct()

Параметры

public__destruct()

protected_replaceTags()

Параметры

protected_write()

Параметры

publicgetOutputAs()

publicgetStyle()

publicsetOutputAs()

publicsetStyle()

Создание или модификация существующего стиля.

Удаление стиля

publicstyleText()

publicstyles()

publicwrite()

Параметры

Подробное описание свойств

$_backgroundColorsprotectedstatic

$_foregroundColorsprotectedstatic

$_optionsprotectedstatic

$_outputprotected

$_outputAsprotected

$_stylesprotectedstatic

`$_backgroundColors`protectedstatic

`$_foregroundColors`protectedstatic

`$_options`protectedstatic

`$_output`protected

`$_outputAs`protected

`$_styles`protectedstatic