Класс ConsoleOutput

use Cake\Console\ConsoleIo;
use Cake\TestSuite\Stub\ConsoleOutput;

$output = new ConsoleOutput();
$io = new ConsoleIo($output);

messages()source public

messages( )

Получить буферизованный вывод.

Возвращает

массив

write()source public

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

Записать вывод в буфер.

Параметры

строка|массив $message

Строка или массив строк для вывода

целое число $newlines необязательно 1

Число символов новой строки для добавления

Переопределяет

Cake\Console\ConsoleOutput::write()

__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 устаревшее

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

Массивовое определение стиля для изменения или создания стиля, или ложь для удаления стиля.

Возвращает

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

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

[]