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

Вводит эмуляцию и заглушки компонентов ввода-вывода в оболочку

Параметры

строка $className

Имя класса

строка $shortName

Короткое имя

Возвращает

Cake\Console\Shell

Переопределяет

Cake\Console\ShellDispatcher::_createShell()

_bootstrap()source protected

_bootstrap( )

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

Возвращает

boolean
Успех.

_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

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

Возвращает

строка|логическое значение
Имя класса или 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 [] )

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

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

Параметры

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

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

Возвращает

целое число
Код выхода команды командной строки. 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