Spec-Zone.ru › CakePHP 3.2

Класс 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–2016 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.
http://api.cakephp.org/3.2/class-Cake.TestSuite.Stub.ConsoleOutput.html

Spec-Zone.ru

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