Класс LegacyShellDispatcher
Позволяет вводить в оболочки поддельные вводы-выводы
Краткое описание свойств
Краткое описание методов
-
__construct() public
Конструктор
-
_bootstrap() protected
Инициализирует среду и загружает ядро CakePHP.
-
_createShell() protected
Вводит в оболочку поддельные и заглушенные компоненты ввода-вывода
-
_dispatch() protected
Обработка запроса.
-
_handleAlias() protected
Если вход соответствует псевдониму, возвращает имя оболочки псевдонима
-
_initEnvironment() protected
Определяет текущую рабочую среду.
-
_shellExists() protected
Проверяет, существует ли класс оболочки для заданного имени.
-
addShortPluginAliases() public
Для всех загруженных плагинов добавьте короткий псевдоним
-
alias() public static
Добавить псевдоним для команды оболочки.
-
dispatch() public
Отправляет запрос CLI
-
findShell() public
Получить оболочку для использования, либо оболочку плагина, либо оболочку приложения
-
help() public
Отображает справку консоли. Выполняет внутреннюю отправку в оболочку CommandList
-
resetAliases() public static
Очистить все установленные псевдонимы.
-
run() public static
Запустить диспетчер
-
shiftArgs() public
Удаляет первый аргумент и сдвигает остальные аргументы вверх
-
version() public
Выводит текущую установленную версию CakePHP. Выполняет внутреннюю отправку в оболочку CommandList
Подробное описание методов
__construct() public
__construct(array $args = [], bool $bootstrap = true, Cake\Console\ConsoleIo|null $io = null)
Конструктор
Параметры
-
array$args необязательно Массив аргументов
-
bool$bootstrap необязательно Инициализировать среду
-
Cake\Console\ConsoleIo|null$io необязательно ConsoleIo
_bootstrap() protected
_bootstrap(): void
Инициализирует среду и загружает ядро CakePHP.
Возвращает
void_createShell() protected
_createShell(string $className, string $shortName): Cake\Console\Shell
Вставляет эмуляции и заглушки компонентов io в оболочку.
Параметры
-
string$className Имя класса
-
string$shortName Короткое имя
Возвращает
Cake\Console\Shell_dispatch() protected
_dispatch(array $extra = []): int|bool|null
Обработка запроса.
Параметры
-
array$extra необязательно Дополнительные параметры, которые можно вручную передать в оболочку для обработки. Встроенный дополнительный параметр:
Возвращает
int|bool|nullИсключения
Cake\Console\Exception\MissingShellMethodException_handleAlias() protected
_handleAlias(string $shell): string
Если вход соответствует псевдониму, возвращает имя оболочки псевдонима.
Параметры
-
string$shell Необязательно, имя плагина или псевдонима
Возвращает
string_initEnvironment() protected
_initEnvironment(): void
Определяет текущую рабочую среду.
Возвращает
voidИсключения
Cake\Core\Exception\CakeException_shellExists() protected
_shellExists(string $shell): string|null
Проверяет, существует ли класс оболочки для данного имени.
Параметры
-
string$shell Имя оболочки для поиска.
Возвращает
string|nulladdShortPluginAliases() public
addShortPluginAliases(): array
Для всех загруженных плагинов добавить короткий псевдоним.
Это позволяет получить доступ к плагину, реализующему оболочку с тем же именем, используя только имя оболочки.
Возвращает
arrayalias() public static
alias(string $short, string|null $original = null): string|null
Добавить псевдоним для команды оболочки.
Псевдонимы позволяют вызывать оболочки альтернативными именами. Это наиболее полезно при работе с оболочками плагинов, для которых вы хотите иметь более короткие имена.
Если вы повторно используете псевдоним, последний заданный псевдоним будет доступным.
Использование
Создание псевдонима для оболочки с именем ClassName:
$this->alias('alias', 'ClassName'); Получение оригинального имени для заданного псевдонима:
$this->alias('alias'); Параметры
-
string$short Новое короткое имя оболочки.
-
string|null$original необязательно Оригинальное полное имя оболочки.
Возвращает
string|nulldispatch() public
dispatch(array $extra = []): int
Обработка запроса командной строки.
Преобразует результат оболочки в код выхода. Значения Null/True рассматриваются как успех. Все другие значения возврата — это ошибка.
Параметры
-
array$extra необязательно Дополнительные параметры, которые можно вручную передать в оболочку для обработки. Встроенный дополнительный параметр:
Возвращает
intfindShell() public
findShell(string $shell): Cake\Console\Shell
Получить оболочку для использования, либо оболочку плагина, либо оболочку приложения.
Все пути в загруженных путях оболочек проверяются, обрабатывается ссылка на псевдоним.
Параметры
-
string$shell Необязательно, имя плагина
Возвращает
Cake\Console\ShellИсключения
Cake\Console\Exception\MissingShellExceptionпри возникновении ошибок.
help() public
help(): void
Отображает справку консоли. Выполняет внутреннюю отправку в оболочку CommandList.
Возвращает
voidresetAliases() public static
resetAliases(): void
Очистить все установленные псевдонимы.
Возвращает
voidrun() public static
run(array $argv, array $extra = []): int
Запустить обработчик.
Параметры
-
array$argv argv из PHP
-
array$extra необязательно Дополнительные параметры
Возвращает
intshiftArgs() public
shiftArgs(): mixed
Удаляет первый аргумент и сдвигает остальные аргументы вверх.
Возвращает
mixedversion() public
version(): void
Выводит текущую установленную версию CakePHP. Выполняет внутреннюю отправку в оболочку CommandList.
Возвращает
voidПодробное описание свойств
$_aliases protected static
Список подключенных псевдонимов.
Тип
array<string, string>$_io protected
Тип
Cake\Console\ConsoleIo$args public
Содержит аргументы, разобранные из командной строки.
Тип
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Console.TestSuite.LegacyShellDispatcher.html
