Класс ConsoleIo

__constructsource 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

_getInputsource protected

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

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

Параметры

строка $prompt

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

строка|null $options

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

строка|null $default

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

Возвращает

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

asksource public

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

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

Параметры

строка $prompt

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

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

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

Возвращает

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

askChoicesource public

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

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

Параметры

строка $prompt

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

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

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

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

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

Возвращает

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

errsource public

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

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

Параметры

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

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

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

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

helpersource public

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

Отображение помощника Console

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

Параметры

строка $name

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

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

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

Возвращает

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

hrsource public

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

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

Параметры

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

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

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

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

levelsource public

level( null|integer $level null )

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

Параметры

null|целое число $level необязательно null

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

Возвращает

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

nlsource public

nl( integer $multiplier 1 )

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

Параметры

целое число $multiplier необязательно 1

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

Возвращает

string
строка

outsource public

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

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

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

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

Параметры

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

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

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

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

целое число $level необязательно Cake\Console\ConsoleIo::NORMAL

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

Возвращает

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

outputAssource public

outputAs( integer $mode )

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

Параметры

целое число $mode

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

См. также

Cake\Console\ConsoleOutput::outputAs()

overwritesource public

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

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

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

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

Параметры

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

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

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

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

целое число $size необязательно null

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

quietsource public

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

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

Параметры

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

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

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

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

Возвращает

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

setLoggerssource public

setLoggers( integer|boolean $enable )

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

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

Параметры

integer|boolean $enable

Используйте boolean для включения/отключения всех логов. Используйте одну из констант уровня подробности (self::VERBOSE, self::QUIET, self::NORMAL) для управления уровнями логов. VERBOSE включает debug-логи, NORMAL не включает debug-логи, QUIET отключает notice, info и debug-логи.

stylessource public

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

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

Параметры

string $style optional null

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

array|boolean|null $definition optional null

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

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

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

См. также

Cake\Console\ConsoleOutput::styles()

verbosesource public

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

Вывод на уровне подробности.

Параметры

string|array $message

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

integer $newlines optional 1

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

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

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

Cake\Console\ConsoleIo::NORMAL