Класс ShellDispatcher
Диспечер Shell обрабатывает отправку команд CLI.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположено по адресу Cake/Console/ShellDispatcher.php
Подробное описание методов
__constructисходный код public
__construct( array $args array() , boolean $bootstrap true )
Конструктор
Выполнение скрипта останавливается после отправки запроса со статусом 0 или 1 в зависимости от результата отправки.
Параметры
- массив
$argsнеобязательно array() - argv из PHP
- логическое значение
$bootstrapнеобязательно true - Нужно ли выполнить загрузку окружения.
_bootstrapисходный код protected
_bootstrap( )
Инициализирует окружение и загружает ядро CakePHP.
Возвращает
booleanУспех.
_getShellисходный код protected
_getShell( string $shell )
Получение используемого shell, либо плагин shell, либо shell приложения
Все пути в загруженных путях shell будут проверены.
Параметры
- строка
$shell - Необязательно, имя плагина
Возвращает
mixedОбъект
Исключения
MissingShellExceptionв случае возникновения ошибок.
_initEnvironmentисходный код protected
_initEnvironment( )
Определяет текущую рабочую среду.
Исключения
CakeExceptionCakeException
_parsePathsисходный код protected
_parsePaths( array $args )
Разбирает пути из argv
Параметры
- массив
$args - argv для разбора.
_stopисходный код protected
_stop( integer|string $status 0 )
Останавливает выполнение текущего скрипта
Параметры
- целое число/строка
$statusнеобязательно 0 - см. http://php.net/exit для значений
dispatchисходный код public
dispatch( )
Отправляет запрос CLI
Возвращает
booleanbool
Исключения
MissingShellMethodExceptionMissingShellMethodException
helpисходный код public
help( )
Отображает справку консоли. Выполняет внутреннюю отправку в CommandList Shell
parseParamsисходный код public
parseParams( array $args )
Парсит параметры командной строки и извлекает пути каталогов из $params
Параметры
- массив
$args - Параметры для разбора
runисходный код public static
run( array $argv )
Запускает диспечер
Параметры
- массив
$argv - argv из PHP
setErrorHandlersисходный код public
setErrorHandlers( )
Устанавливает обработчики ошибок/исключений для консоли на основе значений Error.consoleHandler, и Exception.consoleHandler если они заданы. Если они не заданы, будет использоваться по умолчанию ConsoleErrorHandler.
shiftArgsисходный код public
shiftArgs( )
Удаляет первый аргумент и сдвигает остальные аргументы вверх
Возвращает
mixedNull, если аргументов нет, в противном случае сдвинутый аргумент
Краткое описание свойств
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-ShellDispatcher.html