Класс 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

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

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

__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 )

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

Параметры

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

Возвращает

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

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

$_backgroundColorssource

protected static array

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

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

$_foregroundColorssource

protected static array

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

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

$_optionssource

protected static array

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

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

$_outputsource

protected resource

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

$_outputAssource

protected integer

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

self::COLOR

$_stylessource

protected static array

Стили, доступные в качестве тегов в выводе консоли. Вы можете изменить эти стили с помощью 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–2018 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.5/class-Cake.Console.ConsoleOutput.html