Класс 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

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.

[]