Класс ShellDispatcher
Диспечер оболочки обрабатывает отправку команд cli.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Console/ShellDispatcher.php
Краткое описание свойств
-
$argspublicСодержит аргументы, разобранные из командной строки.array -
$paramspublicСодержит переключатели команд, разобранные из командной строки.array
Краткое описание методов
- __construct() publicКонструктор
- _bootstrap() protectedИнициализирует среду и загружает ядро CakePHP.
- _getShell() protectedПолучить оболочку для использования, либо плагин оболочки, либо оболочка приложения
- _initConstants() protectedОпределяет основные параметры конфигурации.
- _initEnvironment() protectedОпределяет текущую рабочую среду.
- _isAbsolutePath() protectedПроверяет, является ли заданный путь абсолютным или относительным.
- _isWindowsPath() protectedПроверяет, является ли заданный путь путем Windows OS.
- _parsePaths() protectedРазбирает пути из argv
- _stop() protectedОстановить выполнение текущего скрипта
- dispatch() publicОтправляет запрос CLI
- help() publicОтображает справку консоли. Выполняет внутреннюю отправку в оболочку CommandList
- parseParams() publicРазбирает параметры командной строки и извлекает пути каталогов из $params
- Запустить диспечер
- setErrorHandlers() public
Устанавливает обработчики ошибок/исключений для консоли на основе значений
Error.consoleHandler, иException.consoleHandler, если они заданы. Если они не заданы, используется обработчик ошибок ConsoleErrorHandler по умолчанию. - shiftArgs() publicУдаляет первый аргумент и сдвигает другие аргументы вверх
Подробное описание методов
__construct()source public
__construct( array $args array() , boolean $bootstrap true )
Конструктор
Выполнение скрипта останавливается после отправки запроса со статусом кода 0 или 1 в соответствии с результатом отправки.
Параметры
- массив
$argsнеобязательно array() - argv из PHP
- логический
$bootstrapнеобязательно true - Нужно ли инициализировать среду?
_bootstrap()source protected
_bootstrap( )
Инициализирует среду и загружает ядро CakePHP.
Возвращаемые значения
booleanУспех.
_getShell()source protected
_getShell( string $shell )
Получить оболочку для использования, либо плагин оболочки, либо оболочка приложения
Все пути в загруженных путях оболочки проверяются.
Параметры
- строка
$shell - Необязательно, имя плагина
Возвращаемые значения
смешанныйОбъект
Вызывает исключение
MissingShellExceptionпри возникновении ошибок.
_initEnvironment()source protected
_initEnvironment( )
Определяет текущую рабочую среду.
Вызывает исключение
CakeException_isAbsolutePath()source protected
_isAbsolutePath( string $path )
Проверяет, является ли заданный путь абсолютным или относительным.
Параметры
- строка
$path - абсолютный или относительный путь.
Возвращаемые значения
boolean_isWindowsPath()source protected
_isWindowsPath( string $path )
Проверяет, является ли заданный путь путем Windows OS.
Параметры
- строка
$path - абсолютный путь.
Возвращаемые значения
boolean_parsePaths()source protected
_parsePaths( array $args )
Разбирает пути из argv
Параметры
- массив
$args - argv для разбора.
_stop()source protected
_stop( integer|string $status 0 )
Остановить выполнение текущего скрипта
Параметры
- целое число/строка
$statusнеобязательно 0 - см. http://php.net/exit для значений
dispatch()source public
dispatch( )
Отправляет запрос CLI
Возвращаемые значения
booleanВызывает исключение
MissingShellMethodExceptionhelp()source public
help( )
Отображает справку консоли. Выполняет внутреннюю отправку в оболочку CommandList
parseParams()source public
parseParams( array $args )
Разбирает параметры командной строки и извлекает пути каталогов из $params
Параметры
- массив
$args - Параметры для разбора
setErrorHandlers()source public
setErrorHandlers( )
Устанавливает обработчики ошибок/исключений для консоли на основе значений Error.consoleHandler, и Exception.consoleHandler, если они заданы. Если они не заданы, используется обработчик ошибок ConsoleErrorHandler по умолчанию.
shiftArgs()source public
shiftArgs( )
Удаляет первый аргумент и сдвигает другие аргументы вверх
Возвращаемые значения
смешанныйNull, если нет аргументов, иначе сдвинутый аргумент
Подробное описание свойств
© 2005–2017 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.
https://api.cakephp.org/2.10/class-ShellDispatcher.html