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

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

Возвращает

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

askChoice()source public

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

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

Параметры

строка $prompt

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

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

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

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

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

Возвращает

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

createFile()source public

createFile( string $path , string $contents , boolean $forceOverwrite = false )

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

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

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

Параметры

строка $path

Путь для создания файла.

строка $contents

Содержание, которое будет помещено в файл.

логическое значение $forceOverwrite необязательно false

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

Возвращает

логическое значение
Успех.

Исключения

Cake\Console\Exception\StopException

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

err()source public

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

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

Параметры

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

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

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

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

Возвращает

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

error()source public

error( string|array|null $message = null , integer $newlines = 1 )

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

Параметры

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

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

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

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

Возвращает

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

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#ConsoleIo::err

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

info()source public

info( string|array|null $message = null , integer $newlines = 1 , integer $level = self::NORMAL )

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

Параметры

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

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

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

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

целое число $level необязательно self::NORMAL

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

Возвращает

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

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#ConsoleIo::out

level()source public

level( null|integer $level = null )

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

Параметры

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

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

Возвращает

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

nl()source public

nl( integer $multiplier = 1 )

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

Параметры

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

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

Возвращает

строка

out()source public

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

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

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

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

Параметры

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

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

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

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

целое число $level необязательно self::NORMAL

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

Возвращает

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

outputAs()source public устарело

outputAs( integer $mode )

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

Устарело

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

Параметры

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

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

См. также

\Cake\Console\ConsoleOutput::outputAs()

overwrite()source public

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

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

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

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

Параметры

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

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

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

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

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

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

quiet()source public

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

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

Параметры

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

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

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

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

Возвращает

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

setLoggers()source public

setLoggers( integer|boolean $enable )

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

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

Параметры

целое число|логическое значение $enable

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

setOutputAs()source public

setOutputAs( integer $mode )

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

Параметры

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

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

См. также

\Cake\Console\ConsoleOutput::setOutputAs()

styles()source public

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

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

Параметры

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

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

массив|логическое значение|null $definition необязательно null

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

Возвращает

смешанный тип

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

См. также

\Cake\Console\ConsoleOutput::styles()

success()source public

success( string|array|null $message = null , integer $newlines = 1 , integer $level = self::NORMAL )

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

Параметры

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

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

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

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

целое число $level необязательно self::NORMAL

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

Возвращает

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

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#ConsoleIo::out

verbose()source public

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

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

Параметры

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

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

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

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

Возвращает

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

warning()source public

warning( string|array|null $message = null , integer $newlines = 1 )

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

Параметры

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

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

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

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

Возвращает

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

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#ConsoleIo::err

wrapMessageWithType()source protected

wrapMessageWithType( string $messageType , string|array $message )

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

Параметры

строка $messageType

Тип сообщения, например "warning".

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

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

Возвращает

массив|строка
Сообщение, обернутое заданным типом сообщения.

self::NORMAL

false