Класс ConsoleOutputStub

StubOutput упрощает тестирование команд и помощников оболочки.

Вы можете использовать этот класс, добавив его в экземпляр Helper:

App::uses("ConsoleOutputStub", "TestSuite/Stub");

$output = new ConsoleOutputStub();
$helper = new ProgressHelper($output);

ConsoleOutput

ConsoleOutputStub

Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/TestSuite/Stub/ConsoleOutputStub.php

Унаследованные константы

COLOR, LF, PLAIN, RAW

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

$_lastWritten protected

integer
Количество байт, записанных последним вызовом write
$_out protected

array
Буферизованные сообщения.

Унаследованные свойства

_backgroundColors, _foregroundColors, _options, _output, _outputAs, _styles

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

messages() public
Получить буферизованный вывод.
overwrite() public
Перезаписать вывод, уже записанный в буфер.
write() public
Записать вывод в буфер.

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

messages()source public

messages( )

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

Возвращает

array

overwrite()source public

overwrite( array|string $message , integer $newlines 1 , integer $size null )

Перезаписать вывод, уже записанный в буфер.

Параметры

array|string $message: Сообщение для вывода.
integer $newlines опционально 1: Количество символов новой строки для добавления.
integer $size опционально null: Количество байт для перезаписи. По умолчанию равно длине последнего выведенного сообщения.

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

ConsoleOutput::overwrite()

write()source public

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

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

Параметры

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

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

ConsoleOutput::write()

Методы, унаследованные от ConsoleOutput

__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: Сообщение для записи.

Возвращает

boolean
успех

outputAs()source public

outputAs( integer $type null )

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

Параметры

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

Возвращает

mixed
Либо null, либо значение, если выполняется получение.

styleText()source public

styleText( string $text )

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

Параметры

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

Возвращает

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

styles()source public

styles( string $style null , array $definition null )

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

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

$this->output->styles('error');

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

$this->output->styles();

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

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

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

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

Параметры

string $style опционально null: Стили для получения или создания.
array $definition опционально null: Массив, описывающий стиль для изменения или создания стиля, или false для удаления стиля.

Возвращает

mixed

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

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

$_lastWrittensource

protected integer

Количество байт, записанных последним вызовом write

$_outsource

protected array

Буферизованные сообщения.

array()

© 2005–2017 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/2.10/class-ConsoleOutputStub.html