Класс ShellDispatcher

__constructsource public

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

Конструктор

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

Параметры

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

argv из PHP

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

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

_bootstrapsource protected

_bootstrap( )

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

Возвращает

boolean
Успешно.

_createShellsource protected

_createShell( string $className , string $shortName )

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

Параметры

строка $className

Имя класса для создания экземпляра

строка $shortName

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

Возвращает

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

_dispatchsource protected

_dispatch( array $extra [] )

Отправляет запрос.

Параметры

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

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

Возвращает

boolean
bool

Исключения

Cake\Console\Exception\MissingShellMethodException
\Cake\Console\Exception\MissingShellMethodException

_handleAliassource protected

_handleAlias( string $shell )

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

Параметры

строка $shell

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

Возвращает

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

_initEnvironmentsource protected

_initEnvironment( )

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

Исключения

Cake\Core\Exception\Exception
\Cake\Core\Exception\Exception

_shellExistssource protected

_shellExists( string $shell )

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

Параметры

строка $shell

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

Возвращает

string|boolean
Имя класса или false.

addShortPluginAliasessource public

addShortPluginAliases( )

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

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

Возвращает

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

aliassource public static

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

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

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

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

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

Создание псевдонима для оболочки с именем ClassName:

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

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

$this->alias('alias');

Параметры

строка $short

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

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

Оригинальное полное имя оболочки.

Возвращает

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

dispatchsource public

dispatch( array $extra [] )

Отправляет запрос командной строки

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

Параметры

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

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

Возвращает

integer
Код выхода команды командной строки. 0 — успех.

findShellsource public

findShell( string $shell )

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

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

Параметры

строка $shell

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

Возвращает

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

Исключения

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

helpsource public

help( )

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

resetAliasessource public static

resetAliases( )

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

runsource public static

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

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

Параметры

массив $argv

argv из PHP

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

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

Возвращает

integer
Код выхода процесса оболочки.

shiftArgssource public

shiftArgs( )

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

Возвращает

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

[]

[]