Spec-Zone.ru › CakePHP 4.3

Класс ConsoleOutput

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

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

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

$output = new ConsoleOutput();
$io = new ConsoleIo($output);
Пространство имён: Cake\TestSuite\Stub

Константы

  • int
    COLOR 
    2

    Цветной вывод — Преобразует известные теги в ANSI-коды цветных escape-последовательностей.

  • string
    LF 
    PHP_EOL

    Константа для новой строки.

  • int
    PLAIN 
    1

    Обычный вывод — теги будут удалены.

  • int
    RAW 
    0

    Константа для вывода в сыром виде — без модификации текста вывода.

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

  • $_backgroundColors protected static
    array<string, int>

    Цвета фона, используемые в цветном выводе.

  • $_foregroundColors protected static
    array<string, int>

    Цвета текста, используемые в цветном выводе.

  • $_options protected static
    array<string, int>

    Параметры форматирования для цветного вывода.

  • $_out protected
    array<string>

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

  • $_output protected
    resource

    Дескриптор файла для вывода.

  • $_outputAs protected
    int

    Текущий тип вывода.

  • $_styles protected static
    array<string, array>

    Стили, доступные в виде тегов в выводе консоли. Вы можете изменить эти стили с помощью ConsoleOutput::styles()

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

  • __construct() public

    Создать объект вывода.

  • __destruct() public

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

  • _replaceTags() protected

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

  • _write() protected

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

  • getOutputAs() public

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

  • getStyle() public

    Получить доступные стили.

  • messages() public

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

  • output() public

    Получить вывод в виде строки.

  • setOutputAs() public

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

  • setStyle() public

    Установить стиль.

  • styleText() public

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

  • styles() public

    Получить все определения стилей.

  • write() public

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

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

__construct() public 

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

Создать объект вывода.

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

Параметры

string $stream optional

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

__destruct() public 

__destruct()

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

_replaceTags() protected 

_replaceTags(array<string, string> $matches): string

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

Параметры

array<string, string> $matches

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

Возвращает

string

_write() protected 

_write(string $message): int

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

Параметры

string $message

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

Возвращает

int

getOutputAs() public 

getOutputAs(): int

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

Возвращает

int

getStyle() public 

getStyle(string $style): array

Получить доступные стили.

Параметры

string $style

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

Возвращает

array

messages() public 

messages(): array<string>

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

Возвращает

array<string>

output() public 

output(): string

Получить вывод в виде строки.

Возвращает

string

setOutputAs() public 

setOutputAs(int $type): void

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

Параметры

int $type

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

Возвращает

void

Исключение

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

setStyle() public 

setStyle(string $style, array $definition): void

Установить стиль.

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

$output->setStyle('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);

Удалить стиль

$this->output->setStyle('annoy', []);

Параметры

string $style

Стиль для установки.

array $definition

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

Возвращает

void

styleText() public 

styleText(string $text): string

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

Параметры

string $text

Текст с тегами стилей.

Возвращает

string

styles() public 

styles(): array<string, mixed>

Получить все определения стилей.

Возвращает

array<string, mixed>

write() public 

write(array<string>|string $message, int $newlines = 1): int

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

Параметры

array<string>|string $message

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

int $newlines optional

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

Возвращает

int

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

$_backgroundColors protected static

Цвета фона, используемые в цветном выводе.

Тип

array<string, int>

$_foregroundColors protected static

Цвета текста, используемые в цветном выводе.

Тип

array<string, int>

$_options protected static

Параметры форматирования для цветного вывода.

Тип

array<string, int>

$_out protected

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

Тип

array<string>

$_output protected

Дескриптор файла для вывода.

Тип

resource

$_outputAs protected

Текущий тип вывода.

Тип

int

$_styles protected static

Стили, доступные как теги в консольном выводе. Вы можете изменить эти стили с помощью ConsoleOutput::styles()

Тип

array<string, array>

© 2005–present 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/4.3/class-Cake.TestSuite.Stub.ConsoleOutput.html

Spec-Zone.ru

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