Класс ConsoleOutput

Обёртка объекта для вывода информации из приложения оболочки. Может быть подключена к любому ресурсу потока, который может быть использован с fopen()

Может генерировать цветной вывод на консолях, которые его поддерживают. Есть несколько встроенных стилей

error Сообщения об ошибках.
warning Сообщения об ошибках.
info Информационные сообщения.
comment Дополнительный текст.
question Фиолетовый текст, используемый для запросов пользователя

Определяя стили с помощью addStyle(), вы можете создавать пользовательские стили консоли.

Использование стилей в выводе

Вы можете форматировать вывод консоли, используя теги с именем стиля для применения. Изнутри объекта оболочки

$this->out('<warning>Overwrite:</warning> foo.php was overwritten.');

Это создаст оранжевый текст 'Overwrite:', в то время как остальной текст останется обычного цвета. См. ConsoleOutput::styles(), чтобы узнать больше о определении своих собственных стилей. Вложенные стили в данный момент не поддерживаются.

Прямые подклассы

Cake\TestSuite\Stub\ConsoleOutput

Пространство имён: Cake\Console
Расположение: Console/ConsoleOutput.php

Резюме констант

integer

COLOR

2
string

LF

PHP_EOL
integer

PLAIN

1
integer

RAW

0

Резюме свойств

$_backgroundColors protected static

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

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

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

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

integer
Текущий тип вывода. Изменяется с помощью ConsoleOutput::outputAs();
$_styles protected static

array

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

Резюме методов

__construct() public
Конструирование объекта вывода.
__destruct() public
Очистка и закрытие дескрипторов
_replaceTags() protected
Замена тегов на цветовые коды.
_write() protected
Запись сообщения в поток вывода.
getOutputAs() public
Получение типа вывода, определяющего, как обрабатываются теги форматирования.
outputAs() public
Получение/установка типа вывода для использования. Тип вывода, определяющий, как обрабатываются теги форматирования.
setOutputAs() public
Установить тип вывода, определяющий, как обрабатываются теги форматирования.
styleText() public
Применение стилей к тексту.
styles() public
Получение текущих предлагаемых стилей или добавление новых.
write() public

Выводит одно или несколько сообщений в стандартный вывод или стандартный поток ошибок. Если параметры не переданы, выводит только символ новой строки.

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

__construct()source public

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

Конструирование объекта вывода.

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

Параметры

string $stream optional '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 optional 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 optional null: Стиль для получения или создания.
array|boolean|null $definition optional null: Массивно определение стиля для изменения или создания стиля или false для удаления стиля.

Возвращает

mixed

Если вы получаете стили, будет возвращён стиль или null. Если вы создаёте/изменяете стили, будет возвращён true.

END_OF_DOCUMENT_MARKER

write()source public

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

Выводит одно или несколько сообщений в стандартный вывод или стандартный поток ошибок. Если параметры не указаны, выводится только символ новой строки.

Параметры

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

Возвращает

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

Подробности свойств

$_backgroundColorssource

protected static массив

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

[
    'black' => 40,
    'red' => 41,
    'green' => 42,
    'yellow' => 43,
    'blue' => 44,
    'magenta' => 45,
    'cyan' => 46,
    'white' => 47
]

$_foregroundColorssource

protected static массив

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

[
    'black' => 30,
    'red' => 91,
    'green' => 32,
    'yellow' => 33,
    'blue' => 34,
    'magenta' => 35,
    'cyan' => 36,
    'white' => 37
]

$_optionssource

protected static массив

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

[
    'bold' => 1,
    'underline' => 4,
    'blink' => 5,
    'reverse' => 7,
]

$_outputsource

protected ресурс

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

$_outputAssource

protected целое число

Текущий тип вывода. Изменяется с помощью ConsoleOutput::outputAs();

self::COLOR

$_stylessource

protected static массив

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

[
    'emergency' => ['text' => 'red'],
    'alert' => ['text' => 'red'],
    'critical' => ['text' => 'red'],
    'error' => ['text' => 'red'],
    'warning' => ['text' => 'yellow'],
    'info' => ['text' => 'cyan'],
    'debug' => ['text' => 'yellow'],
    'success' => ['text' => 'green'],
    'comment' => ['text' => 'blue'],
    'question' => ['text' => 'magenta'],
    'notice' => ['text' => 'cyan']
]

© 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.4/class-Cake.Console.ConsoleOutput.html