Класс ShellDispatcher

__construct()source public

__construct( array $args = [] , boolean $bootstrap = true )

Конструктор

Выполнение скрипта останавливается после диспетчеризации запроса со статусом кода 0 или 1 в соответствии с результатом диспетчеризации.

Параметры

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

argv из PHP

boolean $bootstrap необязательно true

Нужно ли инициализировать среду.

_bootstrap()source protected

_bootstrap( )

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

Возвращает

boolean
Успех.

_createShell()source protected

_createShell( string $className , string $shortName )

Создаёт указанную оболочку и устанавливает свойство плагина

Параметры

строка $className

Имя класса для инстанцирования

строка $shortName

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

Возвращает

Cake\Console\Shell
Инстанция оболочки.

_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 = [] )

Диспетчеризация запроса CLI

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

Параметры

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

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

Возвращает

целое число
Код выхода команды cli. 0 — успех.

findShell()source public

findShell( string $shell )

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

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

Параметры

строка $shell

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

Возвращает

Cake\Console\Shell
Инстанция оболочки.

Выбрасывает

Cake\Console\Exception\MissingShellException
в случае возникновения ошибок.

help()source public

help( )

Отображает справку консоли. Выполняет внутреннюю передачу в Shell 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 Shell

[]

[]