Класс ConsoleOutput

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

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

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

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

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

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

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

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

Пакет: Cake\Console
Авторские права: Авторские права (с) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение Cake/Console/ConsoleOutput.php

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

__constructsource public

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

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

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

Параметры

строка $stream необязательно 'php://stdout': Идентификатор потока, в который будет записываться вывод.

__destructsource public

__destruct( )

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

_replaceTagssource protected

_replaceTags( array $matches )

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

Параметры

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

Возвращает

string
строка

_writesource protected

_write( string $message )

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

Параметры

строка $message: Сообщение для записи.

Возвращает

boolean
успех

outputAssource public

outputAs( integer $type null )

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

Параметры

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

Возвращает

mixed
Либо null, либо значение, если происходит получение.

styleTextsource public

styleText( string $text )

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

Параметры

строка $text: Текст со стилизующими тегами.

Возвращает

string
Строка с добавленными цветовыми кодами.

stylessource public

styles( string $style null , array $definition null )

Получение текущих доступных стилей или добавление новых.

Получение определения стиля

$this->output->styles('error');

Получение всех определений стилей

$this->output->styles();

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

$this->output->styles('annoy', array('text' => 'purple', 'background' => 'yellow', 'blink' => true));

Удаление стиля

$this->output->styles('annoy', false);

Параметры

строка $style необязательно null: Стиль для получения или создания.
массив $definition необязательно null: Массив определения стиля для изменения или создания стиля, или false для удаления стиля.

Возвращает

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

writesource public

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

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

Параметры

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

Возвращает

integer
Возвращает количество байтов, возвращённых при записи в stdout.

Список констант

`integer`	`COLOR` Вывод цвета - Преобразование известных тегов в коды ANSI-цветов.	`2`
`string`	`LF` Константа для перевода строки.	`PHP_EOL`
`integer`	`PLAIN` Обычный вывод - теги будут удалены.	`1`
`integer`	`RAW` Константа для необработанного вывода - текст вывода не будет модифицирован.	`0`

Список свойств

$_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 ресурс

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

$_outputAssource

protected целое число

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

ConsoleOutput::COLOR

$_stylessource

protected static массив

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

array(
    'emergency' => array('text' => 'red', 'underline' => true),
    'alert' => array('text' => 'red', 'underline' => true),
    'critical' => array('text' => 'red', 'underline' => true),
    'error' => array('text' => 'red', 'underline' => true),
    'warning' => array('text' => 'yellow'),
    'info' => array('text' => 'cyan'),
    'debug' => array('text' => 'yellow'),
    'success' => array('text' => 'green'),
    'comment' => array('text' => 'blue'),
    'question' => array('text' => 'magenta'),
    'notice' => array('text' => 'cyan')
)

© 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/2.7/class-ConsoleOutput.html