Spec-Zone.ru › CakePHP 3.3

Класс ConsoleOutput

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

Вы можете использовать этот класс, внедрив его в экземпляр ConsoleIo, который использует ваша команда/задача/помощник:

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

$output = new ConsoleOutput();
$io = new ConsoleIo($output);
Cake\Console\ConsoleOutput
Расширенный Cake\TestSuite\Stub\ConsoleOutput
Пространство имён: Cake\TestSuite\Stub
Расположение: TestSuite/Stub/ConsoleOutput.php

Наследуемые константы

  • COLOR, LF, PLAIN, RAW

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

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

Наследуемые свойства

  • _backgroundColors, _foregroundColors, _options, _output, _outputAs, _styles

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

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

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

messages()source public

messages( )

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

Возвращаемые значения

массив

write()source public

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

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

Параметры

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

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

Cake\Console\ConsoleOutput::write()

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

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

Возвращаемые значения

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

outputAs()source public

outputAs( integer|null $type null )

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

Параметры

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

Возвращаемые значения

целое число|null
null или значение, если получаем.

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.


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

$_outsource

protected массив

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

[]

© 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/3.3/class-Cake.TestSuite.Stub.ConsoleOutput.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API