Класс ConsoleOutput

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

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

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

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

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

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

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

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

Непосредственные подклассы

• Cake\TestSuite\Stub\ConsoleOutput

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

• integer

  COLOR
  2

• string

  LF
  PHP_EOL

• integer

  PLAIN
  1

• integer

  RAW
  0

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

• $_backgroundColors protected static
  array
  Цвета фона, используемые в цветном выводе.
• $_foregroundColors protected static
  array
  Цвета текста, используемые в цветном выводе.
• $_options protected static
  string
  Параметры форматирования для цветного вывода
• $_output protected
  resource
  Дескриптор файла для вывода.
• $_outputAs protected
  integer
  Текущий тип вывода. Изменяется с помощью ConsoleOutput::outputAs();
• $_styles protected static
  array

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

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

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

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

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

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

__destruct( )

_replaceTags( array $matches )

_write( string $message )

outputAs( integer|null $type null )

styleText( string $text )

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

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

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

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

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

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

self::COLOR

[
    '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']
]