Класс LegacyShellDispatcher

__construct()source public

__construct( array $args = [] , boolean $bootstrap = true , Cake\Console\ConsoleIo $io = null )

Конструктор

Параметры

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

Массив аргументов

логическое значение $bootstrap необязательный true

Инициализировать среду

Cake\Console\ConsoleIo $io необязательный null

ConsoleIo

Переопределяет

Cake\Console\ShellDispatcher::__construct()

_createShell()source protected

_createShell( string $className , string $shortName )

Встраивает эмуляцию и заглушки компонентов ввода-вывода в оболочку

Параметры

строка $className

Имя класса

строка $shortName

Короткое имя

Возвращает

Cake\Console\Shell

Переопределяет

Cake\Console\ShellDispatcher::_createShell()

_bootstrap()source protected

_bootstrap( )

Инициализирует среду и загружает ядро CakePHP.

Возвращает

boolean
Результат.

_dispatch()source protected

_dispatch( array $extra = [] )

Обработка запроса.

Параметры

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

Дополнительные параметры, которые можно вручную передать оболочке для обработки. Встроенный дополнительный параметр: - requested : если используется, то сообщение приветствия оболочки не будет отображаться

Возвращает

boolean|integer|null

Возможные исключения

Cake\Console\Exception\MissingShellMethodException

_handleAlias()source protected

_handleAlias( string $shell )

Если вход соответствует псевдониму, вернуть имя оболочки с псевдонимом

Параметры

строка $shell

Необязательно имя плагина или псевдонима

Возвращает

строка
Имя оболочки с префиксом плагина

_initEnvironment()source protected

_initEnvironment( )

Определяет текущую рабочую среду.

Возможные исключения

Cake\Core\Exception\Exception

_shellExists()source protected

_shellExists( string $shell )

Проверить, существует ли класс оболочки для данного имени.

Параметры

строка $shell

Имя оболочки для поиска.

Возвращает

строка|boolean
Либо имя класса, либо false.

addShortPluginAliases()source public

addShortPluginAliases( )

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

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

Возвращает

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

alias()source public static

alias( string $short , string|null $original = null )

Добавить псевдоним для команды оболочки.

Псевдонимы позволяют вызывать оболочки с альтернативными именами. Это особенно полезно при работе с оболочками плагинов, для которых вы хотите иметь более короткие имена.

Если вы повторно используете псевдоним, последняя установленная версия будет доступна.

Использование

Присвоение псевдонима оболочке с именем ClassName:

$this->alias('alias', 'ClassName');

Получение оригинального имени для заданного псевдонима:

$this->alias('alias');

Параметры

строка $short

Новое короткое имя оболочки.

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

Исходное полное имя оболочки.

Возвращает

строка|false
Имя класса с псевдонимом, или false, если псевдонима не существует

dispatch()source public

dispatch( array $extra = [] )

Обработка запроса командной строки

Преобразует результат команды оболочки в код завершения. Null/True обрабатываются как успешные. Все остальные возвращаемые значения — ошибки.

Параметры

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

Дополнительные параметры, которые можно вручную передать оболочке для обработки. Встроенный дополнительный параметр: - requested : если используется, то сообщение приветствия оболочки не будет отображаться

Возвращает

целое число
Код завершения команды командной строки. 0 — успех.

findShell()source public

findShell( string $shell )

Получение оболочки для использования, либо оболочка плагина, либо оболочка приложения

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

Параметры

строка $shell

Необязательно имя плагина

Возвращает

Cake\Console\Shell
Экземпляр оболочки.

Возможные исключения

Cake\Console\Exception\MissingShellException
при возникновении ошибок.

help()source public

help( )

Отображает справку консоли. Выполняет внутреннюю обработку для оболочки CommandList

resetAliases()source public static

resetAliases( )

Очистить все установленные псевдонимы.

run()source public static

run( array $argv , array $extra = [] )

Запустить диспетчер

Параметры

массив $argv

argv из PHP

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

Дополнительные параметры

Возвращает

целое число
Код завершения процесса оболочки.

shiftArgs()source public

shiftArgs( )

Удаляет первый аргумент и сдвигает остальные аргументы вверх

Возвращает

смешанный тип
Null, если аргументов нет, в противном случае сдвинутый аргумент

version()source public

version( )

Выводит текущую установленную версию CakePHP. Выполняет внутреннюю обработку для оболочки CommandList