Класс ShellDispatcher

Shell dispatcher обрабатывает отправку команд CLI.

Пакет: Cake\Console
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/ShellDispatcher.php

Краткое описание свойств

$args public

array
Содержит аргументы, распарсенные из командной строки.
$params public

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
run() public static
Запустить диспетчер
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: Необязательно, имя плагина

Возвращает

mixed
Объект

Выбрасывает

MissingShellException
при возникновении ошибок.

_initConstants()source protected

_initConstants( )

Определяет основные конфигурации.

_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

Выбрасывает

MissingShellMethodException

help()source public

help( )

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

parseParams()source public

parseParams( array $args )

Парсит параметры командной строки и извлекает пути к каталогам из $params

Параметры

массив $args: Параметры для парсинга

run()source public static

run( array $argv )

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

Параметры

массив $argv: argv из PHP

setErrorHandlers()source public

setErrorHandlers( )

Устанавливает обработчики ошибок/исключений для консоли на основе значений Error.consoleHandler, и Exception.consoleHandler , если они заданы. Если они не заданы, используется обработчик ошибок по умолчанию ConsoleErrorHandler.

shiftArgs()source public

shiftArgs( )

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

Возвращает

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

Подробное описание свойств

$argssource

public массив

Содержит аргументы, распарсенные из командной строки.

array()

END_OF_DOCUMENT_MARKER

$paramssource

public array

Содержит переключатели команд, разобранные из командной строки.

array()

© 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.
https://api.cakephp.org/2.9/class-ShellDispatcher.html