Класс ConsoleIo

Обёртка вокруг различных операций ввода-вывода, необходимых для задач командной оболочки.

Объединяет потоки stdout, stderr и stdin, предоставляя простой и согласованный интерфейс для использования оболочками. Этот класс также упрощает моделирование потоков в модульных тестах.

Пространство имён: Cake\Console

Константы

int

NORMAL
```
1
```
Константа вывода для создания обычных оболочек.
int

QUIET
```
0
```
Константы вывода для создания тихих оболочек.
int

VERBOSE
```
2
```
Константа вывода для создания подробных оболочек.

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

$_err protected

Cake\Console\ConsoleOutput

Поток ошибок
$_helpers protected

Cake\Console\HelperRegistry

Регистр помощников.
$_in protected

Cake\Console\ConsoleInput

Поток ввода
$_lastWritten protected

int

Количество байтов, последними записанных в поток вывода, используется при перезаписи предыдущего сообщения.
$_level protected

int

Текущий уровень вывода.
$_out protected

Cake\Console\ConsoleOutput

Поток вывода
$forceOverwrite protected

bool

Нужно ли перезаписывать файлы?
$interactive protected

bool

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

__construct() public

Конструктор
_getInput() protected

Запрашивает у пользователя ввод и возвращает его.
abort() public

Прерывает текущий процесс с исключением StopException.
ask() public

Запрашивает у пользователя ввод и возвращает его.
askChoice() public

Запрашивает у пользователя ввод на основе списка вариантов и возвращает его.
comment() public

Удобный метод для out(), который оборачивает сообщение тегами .
createFile() public

Создаёт файл по заданному пути.
err() public

Выводит одно или несколько сообщений об ошибках в stderr. Если параметры не указаны, выводит только новую строку.
error() public

Удобный метод для err(), который оборачивает сообщение тегами .
getStyle() public

Получить определённый стиль.
helper() public

Отобразить помощника командной строки.
hr() public

Выводит серию символов минус в стандартный вывод, служит визуальным разделителем.
info() public

Удобный метод для out(), который оборачивает сообщение тегами .
level() public

Получить/установить текущий уровень вывода.
nl() public

Возвращает одну или несколько последовательностей символов перевода строки.
out() public

Выводит одно или несколько сообщений в stdout. Если параметры не указаны, выводит только новую строку.
overwrite() public

Перезаписывает часть уже выведенного текста.
quiet() public

Вывод на всех уровнях.
setInteractive() public
setLoggers() public

Подключает или отключает логгеры к выводу консоли.
setOutputAs() public

Изменить режим вывода потока stdout.
setStyle() public

Добавляет новый стиль вывода.
styles() public

Получить определённые стили.
success() public

Удобный метод для out(), который оборачивает сообщение тегами .
verbose() public

Вывод на подробном уровне.
warning() public

Удобный метод для err(), который оборачивает сообщение тегами .
wrapMessageWithType() protected

Оборачивает сообщение заданным типом сообщения, например,

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct(Cake\Console\ConsoleOutput|null $out = null, Cake\Console\ConsoleOutput|null $err = null, Cake\Console\ConsoleInput|null $in = null, Cake\Console\HelperRegistry|null $helpers = null)

Конструктор

Параметры

Cake\Console\ConsoleOutput|null $out optional: Объект ConsoleOutput для stdout.
Cake\Console\ConsoleOutput|null $err optional: Объект ConsoleOutput для stderr.
Cake\Console\ConsoleInput|null $in optional: Объект ConsoleInput для stdin.
Cake\Console\HelperRegistry|null $helpers optional: Экземпляр HelperRegistry

_getInput() protected

_getInput(string $prompt, string|null $options, string|null $default): string

Запрашивает у пользователя ввод и возвращает его.

Параметры

string $prompt: Текст запроса.
string|null $options: Строка параметров. Передайте null, чтобы пропустить.
string|null $default: Значение по умолчанию. Передайте null, чтобы пропустить.

Возвращает

string

abort() public

abort(string $message, int $code = CommandInterface::CODE_ERROR): void

Приостанавливает текущий процесс с помощью StopException.

Параметры

string $message: Сообщение об ошибке.
int $code optional: Код ошибки.

Возвращает

void

Вызывает исключение

Cake\Console\Exception\StopException

ask() public

ask(string $prompt, string|null $default = null): string

Запрашивает у пользователя ввод и возвращает его.

Параметры

string $prompt: Текст запроса.
string|null $default optional: Значение ввода по умолчанию.

Возвращает

string

askChoice() public

askChoice(string $prompt, string|array $options, string|null $default = null): string

Запрашивает у пользователя ввод на основе списка параметров и возвращает его.

Параметры

string $prompt: Текст запроса.
string|array $options: Массив или строка параметров.
string|null $default optional: Значение ввода по умолчанию.

Возвращает

string

comment() public

comment(string|string[] $message, int $newlines = 1, int $level = self::NORMAL): int|null

Вспомогательный метод для out(), который заключает сообщение в теги

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество символов перевода строки для добавления
int $level optional: Уровень вывода сообщения, см. выше.

Возвращает

int|null

См. также

https://book.cakephp.org/4/en/console-and-shells.html#ConsoleIo::out

createFile() public

createFile(string $path, string $contents, bool $forceOverwrite = false): bool

Создает файл по указанному пути.

Этот метод запросит подтверждение у пользователя, если файл будет перезаписан. Установка forceOverwrite в true подавит это поведение и всегда будет перезаписывать файл.

Если пользователь отвечает a последующие forceOverwrite параметры будут приведены к true, и все файлы будут перезаписаны.

Параметры

string $path: Путь для создания файла.
string $contents: Содержимое для размещения в файле.
bool $forceOverwrite optional: Следует ли перезаписывать файл. Если true, вопрос о перезаписи существующих файлов задаваться не будет.

Возвращает

bool

Вызывает исключение

Cake\Console\Exception\StopException
Когда в ответ на вопрос о перезаписи файла указывается `q`.

err() public

err(string|string[] $message = '', int $newlines = 1): int

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

Параметры

string|string[] $message optional: Строка или массив строк для вывода
int $newlines optional: Количество символов перевода строки для добавления

Возвращает

int

error() public

error(string|string[] $message, int $newlines = 1): int

Вспомогательный метод для err(), который заключает сообщение в теги

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество символов перевода строки для добавления

Возвращает

int

См. также

https://book.cakephp.org/4/en/console-and-shells.html#ConsoleIo::err

getStyle() public

getStyle(string $style): array

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

Параметры

string $style: Стиль для получения.

Возвращает

array

См. также

\Cake\Console\ConsoleOutput::getStyle()

helper() public

helper(string $name, array $settings = []): Cake\Console\Helper

Рендеринг вспомогательного модуля Console

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

Параметры

string $name: Имя вспомогательного модуля для визуализации
array $settings optional: Данные конфигурации для вспомогательного модуля.

Возвращает

Cake\Console\Helper

hr() public

hr(int $newlines = 0, int $width = 79): void

Выводит серию символов минус в стандартный вывод, выступает в качестве визуального разделителя.

Параметры

int $newlines optional: Количество символов перевода строки для добавления до и после
int $width optional: Ширина линии, по умолчанию 79

Возвращает

void

info() public

info(string|string[] $message, int $newlines = 1, int $level = self::NORMAL): int|null

Вспомогательный метод для out(), который заключает сообщение в теги

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество символов перевода строки для добавления
int $level optional: Уровень вывода сообщения, см. выше.

Возвращает

int|null

См. также

https://book.cakephp.org/4/en/console-and-shells.html#ConsoleIo::out

level() public

level(int|null $level = null): int

Получить/установить текущий уровень вывода.

Параметры

int|null $level optional: Текущий уровень вывода.

Возвращает

int

nl() public

nl(int $multiplier = 1): string

Возвращает одну или несколько последовательностей символов перевода строки.

Параметры

int $multiplier optional: Количество повторов последовательности символов перевода строки

Возвращает

string

out() public

out(string|string[] $message = '', int $newlines = 1, int $level = self::NORMAL): int|null

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

Уровни вывода

Существует 3 встроенных уровня вывода. ConsoleIo::QUIET, ConsoleIo::NORMAL, ConsoleIo::VERBOSE. Уровни вывода verbose и quiet соответствуют переключателям вывода verbose и quiet в большинстве оболочек. Использование ConsoleIo::QUIET для сообщения означает, что оно всегда будет отображаться. Использование ConsoleIo::VERBOSE означает, что оно будет отображаться только при включенном подробном выводе.

Параметры

string|string[] $message optional: Строка или массив строк для вывода
int $newlines optional: Количество переводов строк для добавления
int $level optional: Уровень вывода сообщения, см. выше.

Возвращает

int|null

overwrite() public

overwrite(array|string $message, int $newlines = 1, int|null $size = null): void

Перезаписывает уже выведенный текст.

Полезно для создания прогресс-баров или когда требуется заменить уже выведенный на экран текст новым.

Предупреждение Вы не можете перезаписать текст, содержащий переводы строк.

Параметры

array|string $message: Сообщение для вывода.
int $newlines optional: Количество переводов строк для добавления.
int|null $size optional: Количество байтов для перезаписи. По умолчанию равно длине последнего выведенного сообщения.

Возвращает

void

quiet() public

quiet(string|string[] $message, int $newlines = 1): int|null

Вывод на всех уровнях.

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество переводов строк для добавления

Возвращает

int|null

setInteractive() public

setInteractive(bool $value): void

Параметры

bool $value: Значение

Возвращает

void

setLoggers() public

setLoggers(int|bool $enable): void

Подключает или отключает логгеры к выводу консоли.

Используется для включения или отключения вывода логов в stdout и stderr через класс Cake's Log. Если вы не хотите весь вывод логов в stdout или stderr через класс Cake's Log, вызовите эту функцию с $enable=false.

Параметры

int|bool $enable: Используйте булево значение для включения/отключения всех логов. Используйте одну из констант подробности (self::VERBOSE, self::QUIET, self::NORMAL) для управления уровнями логов. VERBOSE включает отладочные логи, NORMAL не включает отладочные логи, QUIET отключает уведомления, информацию и отладочные логи.

Возвращает

void

setOutputAs() public

setOutputAs(int $mode): void

Изменить режим вывода потока stdout

Параметры

int $mode: Режим вывода.

Возвращает

void

См. также

\Cake\Console\ConsoleOutput::setOutputAs()

setStyle() public

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

Добавляет новый стиль вывода.

Параметры

string $style: Стиль для установки.
array $definition: Массивная структура определения стиля для изменения или создания.

Возвращает

void

См. также

\Cake\Console\ConsoleOutput::setStyle()

styles() public

styles(): array

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

Возвращает

array

См. также

\Cake\Console\ConsoleOutput::styles()

success() public

success(string|string[] $message, int $newlines = 1, int $level = self::NORMAL): int|null

Удобный метод для out(), который оборачивает сообщение тегами

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество переводов строк для добавления
int $level optional: Уровень вывода сообщения, см. выше.

Возвращает

int|null

См. также

https://book.cakephp.org/4/en/console-and-shells.html#ConsoleIo::out

verbose() public

verbose(string|string[] $message, int $newlines = 1): int|null

Вывод на уровне verbose.

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество переводов строк для добавления

Возвращает

int|null

warning() public

warning(string|string[] $message, int $newlines = 1): int

Удобный метод для err(), который оборачивает сообщение тегами

Параметры

string|string[] $message: Строка или массив строк для вывода
int $newlines optional: Количество переводов строк для добавления

Возвращает

int

См. также

https://book.cakephp.org/4/en/console-and-shells.html#ConsoleIo::err

wrapMessageWithType() protected

wrapMessageWithType(string $messageType, string|string[] $message): string|string[]

Оборачивает сообщение заданным типом сообщения, например:

Параметры

string $messageType: Тип сообщения, например, "warning".
string|string[] $message: Оборачиваемое сообщение.

Возвращает

string|string[]

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

`$_err` protected

Поток ошибок

Тип

Cake\Console\ConsoleOutput

`$_helpers` protected

Регистр помощников.

Тип

Cake\Console\HelperRegistry

`$_in` protected

Поток ввода

Тип

Cake\Console\ConsoleInput

`$_lastWritten` protected

Количество байтов, последне записанных в поток вывода, используется при перезаписи предыдущего сообщения.

Тип

int

`$_level` protected

Текущий уровень вывода.

Тип

int

`$_out` protected

Поток вывода

Тип

Cake\Console\ConsoleOutput

`$forceOverwrite` protected

Надо ли перезаписывать файлы

Тип

bool

`$interactive` protected

Тип

bool

© 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.2/class-Cake.Console.ConsoleIo.html