Класс 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 optional null

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

Cake\Console\ConsoleOutput $err optional null

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

Cake\Console\ConsoleInput $in optional null

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

Cake\Console\HelperRegistry $helpers optional null

Экземпляр HelperRegistry

_getInput()source protected

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

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

Параметры

string $prompt

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

string|null $options

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

string|null $default

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

Возвращает

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

ask()source public

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

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

Параметры

string $prompt

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

string|null $default optional null

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

Возвращает

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

askChoice()source public

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

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

Параметры

string $prompt

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

string|array $options

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

string|null $default optional null

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

Возвращает

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

err()source public

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

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

Параметры

string|array $message optional ''

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

integer $newlines optional 1

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

Возвращает

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

helper()source public

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

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

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

Параметры

string $name

Имя вспомогательного элемента для рендеринга

array $settings optional []

Данные конфигурации для вспомогательного элемента.

Возвращает

Cake\Console\Helper
Созданный экземпляр вспомогательного элемента.

hr()source public

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

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

Параметры

integer $newlines optional 0

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

integer $width optional 79

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

level()source public

level( null|integer $level null )

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

Параметры

null|integer $level optional null

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

Возвращает

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

nl()source public

nl( integer $multiplier 1 )

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

Parameters

integer $multiplier optional 1

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

Returns

string

out()source public

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

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

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

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

Parameters

string|array $message optional ''

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

integer $newlines optional 1

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

integer $level optional ConsoleIo::NORMAL

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

Returns

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

outputAs()source public

outputAs( integer $mode )

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

Parameters

integer $mode

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

See

\Cake\Console\ConsoleOutput::outputAs()

overwrite()source public

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

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

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

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

Parameters

array|string $message

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

integer $newlines optional 1

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

integer|null $size optional null

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

quiet()source public

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

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

Parameters

string|array $message

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

integer $newlines optional 1

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

Returns

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

setLoggers()source public

setLoggers( integer|boolean $enable )

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

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

Parameters

integer|boolean $enable

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

styles()source public

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

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

Parameters

string|null $style optional null

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

array|boolean|null $definition optional null

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

Returns

mixed

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

See

\Cake\Console\ConsoleOutput::styles()

verbose()source public

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

Вывод на подробном уровне.

Parameters

string|array $message

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

integer $newlines optional 1

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

Returns

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

ConsoleIo::NORMAL