Класс ConsoleOutput

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

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

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

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

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

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

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

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

Прямые подклассы

Cake\TestSuite\Stub\ConsoleOutput

Пространство имён: Cake\Console
Расположение: Console/ConsoleOutput.php

Краткое описание констант

integer

COLOR

2
string

LF

PHP_EOL
integer

PLAIN

1
integer

RAW

0

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

$_backgroundColors protected static

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

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

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

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

integer
Текущий тип вывода. Изменяется с помощью ConsoleOutput::outputAs();
$_styles protected static

array

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

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

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

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

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

__construct()source public

__construct( string $stream = 'php://stdout' )

Конструктор объекта вывода.

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

Параметры

строка $stream необязательно 'php://stdout': Идентификатор потока для записи вывода.

__destruct()source public

__destruct( )

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

_replaceTags()source protected

_replaceTags( array $matches )

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

Параметры

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

Возвращает

строка

_write()source protected

_write( string $message )

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

Параметры

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

Возвращает

целое число/логическое значение
Количество байтов, возвращённых из записи в выходной поток.

getOutputAs()source public

getOutputAs( )

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

Возвращает

целое число

outputAs()source public deprecated

outputAs( integer|null $type = null )

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

Устарело

3.5.0 Используйте getOutputAs()/setOutputAs() вместо этого.

Параметры

целое число/null $type необязательно null: Тип вывода для использования. Должен быть одной из констант класса.

Возвращает

целое число/null
Либо null, либо значение при получении.

setOutputAs()source public

setOutputAs( integer $type )

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

Параметры

целое число $type: Тип вывода для использования. Должен быть одной из констант класса.

Исключения

InvalidArgumentException
в случае неподдерживаемого типа вывода.

styleText()source public

styleText( string $text )

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

Параметры

строка $text: Текст со стилизованными тегами.

Возвращает

строка
Строка с добавленными кодами цвета.

styles()source public

styles( string|null $style = null , array|boolean|null $definition = null )

Получить доступные стили или добавить новые.

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

$output->styles('error');

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

$output->styles();

Создать или изменить существующий стиль

$output->styles('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);

Удалить стиль

$this->output->styles('annoy', false);

Параметры

строка/null $style необязательно null: Стиль для получения или создания.
массив/логическое значение/null $definition необязательно null: Массив определения стиля для изменения или создания стиля, либо false для удаления стиля.

Возвращает

смешанный тип

Если получаете стили, возвращается стиль или null. Если создаёте/изменяете стили, возвращается true.

write()source public

write( string|array $message , integer $newlines = 1 )

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

Параметры

строка|массив $message: Строка или массив строк для вывода
целое число $newlines необязательный 1: Количество переводов строк для добавления

Возвращает

целое число|булево
Количество байт, возвращенных при записи в выходной поток.

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

$_backgroundColorssource

protected static массив

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

[
    'black' => 40,
    'red' => 41,
    'green' => 42,
    'yellow' => 43,
    'blue' => 44,
    'magenta' => 45,
    'cyan' => 46,
    'white' => 47
]

$_foregroundColorssource

protected static массив

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

[
    'black' => 30,
    'red' => 31,
    'green' => 32,
    'yellow' => 33,
    'blue' => 34,
    'magenta' => 35,
    'cyan' => 36,
    'white' => 37
]

$_optionssource

protected static массив

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

[
    'bold' => 1,
    'underline' => 4,
    'blink' => 5,
    'reverse' => 7,
]

$_outputsource

protected ресурс

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

$_outputAssource

protected целое число

Текущий тип вывода. Изменяется с помощью ConsoleOutput::outputAs();

self::COLOR

$_stylessource

protected static массив

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

[
    'emergency' => ['text' => 'red'],
    'alert' => ['text' => 'red'],
    'critical' => ['text' => 'red'],
    'error' => ['text' => 'red'],
    'warning' => ['text' => 'yellow'],
    'info' => ['text' => 'cyan'],
    'debug' => ['text' => 'yellow'],
    'success' => ['text' => 'green'],
    'comment' => ['text' => 'blue'],
    'question' => ['text' => 'magenta'],
    'notice' => ['text' => 'cyan']
]

© 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/3.8/class-Cake.Console.ConsoleOutput.html