Класс ShellDispatcher

__construct()source public

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

Конструктор

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

Параметры

массив $args опционально []

argv из PHP

логическое $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

Исключения

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. Выполняет внутреннюю отправку в командный Shell CommandList

[]

[]