Класс ConsoleIo

__construct()source public

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

Конструктор

Параметры

Cake\Console\ConsoleOutput $out необязательно null

Объект ConsoleOutput для stdout.

Cake\Console\ConsoleOutput $err необязательно null

Объект ConsoleOutput для stderr.

Cake\Console\ConsoleInput $in необязательно null

Объект ConsoleInput для stdin.

Cake\Console\HelperRegistry $helpers необязательно null

Экземпляр HelperRegistry

_getInput()source protected

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

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

Параметры

строка $prompt

Текст запроса.

строка|null $options

Строка вариантов. Передайте null, чтобы опустить.

строка|null $default

Значение ввода по умолчанию. Передайте null, чтобы опустить.

Возвращаемое значение

строка
Либо значение по умолчанию, либо введённое пользователем.

ask()source public

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

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

Параметры

строка $prompt

Текст запроса.

строка|null $default необязательно null

Значение ввода по умолчанию.

Возвращаемое значение

mixed
Либо значение по умолчанию, либо введённое пользователем.

askChoice()source public

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

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

Параметры

строка $prompt

Текст запроса.

строка|массив $options

Массив или строка вариантов.

строка|null $default необязательно null

Значение ввода по умолчанию.

Возвращаемое значение

mixed
Либо значение по умолчанию, либо введённое пользователем.

err()source public

err( string|array $message '' , integer $newlines 1 )

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

Параметры

строка|массив $message необязательно ''

Строка или массив строк для вывода

целое $newlines необязательно 1

Количество символов новой строки для добавления

Возвращаемое значение

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

helper()source public

helper( string $name , array $settings [] )

Отобразить помощника консоли

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

Параметры

строка $name

Имя помощника для отображения

массив $settings необязательно []

Данные конфигурации для помощника.

Возвращаемое значение

Cake\Console\Helper
Созданный экземпляр помощника.

hr()source public

hr( integer $newlines 0 , integer $width 79 )

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

Параметры

целое $newlines необязательно 0

Количество символов новой строки для добавления до и после

целое $width необязательно 79

Ширина строки, по умолчанию 79

level()source public

level( null|integer $level null )

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

Параметры

null|integer $level необязательно null

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

Возвращает

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

nl()source public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier необязательно 1

Количество повторений последовательности символов новой строки.

Возвращает

string

out()source public

out( string|array $message '' , integer $newlines 1 , integer $level ConsoleIo::NORMAL )

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

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

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

Параметры

string|array $message необязательно ''

Строка или массив строк для вывода

integer $newlines необязательно 1

Количество символов новых строк для добавления

integer $level необязательно ConsoleIo::NORMAL

Уровень вывода сообщения, см. выше.

Возвращает

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

outputAs()source public

outputAs( integer $mode )

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

Устарело

3.5.0 Используйте setOutputAs() вместо этого.

Параметры

integer $mode

Режим вывода.

См. также

\Cake\Console\ConsoleOutput::outputAs()

overwrite()source public

overwrite( array|string $message , integer $newlines 1 , integer|null $size null )

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

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

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

Параметры

array|string $message

Сообщение для вывода.

integer $newlines необязательно 1

Количество символов новых строк для добавления.

integer|null $size необязательно null

Количество байтов для перезаписи. По умолчанию равно длине последнего выведенного сообщения.

quiet()source public

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

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

Параметры

string|array $message

Строка или массив строк для вывода

integer $newlines необязательно 1

Количество символов новых строк для добавления

Возвращает

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

setLoggers()source public

setLoggers( integer|boolean $enable )

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

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

Параметры

integer|boolean $enable

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

setOutputAs()source public

setOutputAs( integer $mode )

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

Параметры

integer $mode

Режим вывода.

См. также

\Cake\Console\ConsoleOutput::setOutputAs()

styles()source public

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

Добавление нового стиля вывода или получение определенных стилей.

Параметры

string|null $style необязательно null

Стиль для получения или создания.

array|boolean|null $definition необязательно null

Массивная структура определения стиля для изменения или создания стиля, или false для удаления стиля.

Возвращает

mixed

При получении стилей возвращается стиль или null. При создании/изменении стилей возвращается true.

См. также

\Cake\Console\ConsoleOutput::styles()

verbose()source public

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

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

Параметры

string|array $message

Строка или массив строк для вывода

integer $newlines необязательно 1

Количество символов новых строк для добавления

Возвращает

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

ConsoleIo::NORMAL