Класс 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 )

Вводит в оболочку поддельные и имитирующие компоненты IO

Параметры

строка $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 [] )

Обработка запроса 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( )

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