Spec-Zone.ru › CakePHP 2.10

Класс ShellDispatcher

Диспечер оболочки обрабатывает отправку команд cli.

Пакет: Cake\Console
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: 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
Необязательно, имя плагина

Возвращаемые значения

смешанный
Объект

Вызывает исключение

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

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( )

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

Возвращаемые значения

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

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

$argssource

public массив

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

array()

$paramssource

public массив

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

array()

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API