Класс ConsoleOutput

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

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

messages()source public

messages( )

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

Возвращает

array

write()source public

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

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

Параметры

string|array $message

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

integer $newlines опционально 1

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

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

Cake\Console\ConsoleOutput::write()

__construct()source public

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

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

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

Параметры

string $stream опционально 'php://stdout'

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

__destruct()source public

__destruct( )

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

_replaceTags()source protected

_replaceTags( array $matches )

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

Параметры

array $matches

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

Возвращает

string

_write()source protected

_write( string $message )

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

Параметры

string $message

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

Возвращает

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

getOutputAs()source public

getOutputAs( )

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

Возвращает

integer

outputAs()source public deprecated

outputAs( integer|null $type = null )

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

Устарело

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

Параметры

integer|null $type опционально null

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

Возвращает

integer|null
Либо null, либо значение, если происходит получение.

setOutputAs()source public

setOutputAs( integer $type )

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

Параметры

integer $type

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

Исключения

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

styleText()source public

styleText( string $text )

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

Параметры

string $text

Текст со стилями тегов.

Возвращает

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

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);

Параметры

string|null $style опционально null

Стиль для получения или создания.

array|boolean|null $definition опционально null

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

Возвращает

mixed

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

[]