Класс 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, не будет задаваться вопрос о перезаписи существующих файлов.

Возвращает

boolean
Успех.

Выбрасывает

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 deprecated

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 через класс Cake's Log. Если вы не хотите, чтобы весь вывод логов в stdout или stderr проходил через класс Cake's Log, вызовите эту функцию со значением $enable=false.

Параметры

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

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

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

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

Возвращает

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

См. также

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

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

Возвращает

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

warning()source public

warning( 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

wrapMessageWithType()source protected

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

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

Параметры

строка $messageType

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

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

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

Возвращает

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

self::NORMAL

false