Class ShellDispatcher
Shell dispatcher handles dispatching cli commands.
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Console/ShellDispatcher.php
Properties summary
Method Summary
-
__construct() public
Constructor -
_bootstrap() protected
Initializes the environment and loads the CakePHP core. -
_getShell() protected
Get shell to use, either plugin shell or application shell -
_initConstants() protected
Defines core configuration. -
_initEnvironment() protected
Defines current working environment. -
_isAbsolutePath() protected
Checks whether the given path is absolute or relative. -
_isWindowsPath() protected
Checks whether the given path is Window OS path. -
_parsePaths() protected
Parses out the paths from from the argv -
_stop() protected
Stop execution of the current script -
dispatch() public
Dispatches a CLI request -
help() public
Shows console help. Performs an internal dispatch to the CommandList Shell -
parseParams() public
Parses command line options and extracts the directory paths from $params -
run() public static
Run the dispatcher -
setErrorHandlers() public
Set the error/exception handlers for the console based on the
Error.consoleHandler, andException.consoleHandlervalues if they are set. If they are not set, the default ConsoleErrorHandler will be used. -
shiftArgs() public
Removes first argument and shifts other arguments up
Method Detail
__construct() public ¶
__construct( array $args = array() , boolean $bootstrap = true )
Constructor
The execution of the script is stopped after dispatching the request with a status code of either 0 or 1 according to the result of the dispatch.
Parameters
- array $args optional array()
- the argv from PHP
- boolean $bootstrap optional true
- Should the environment be bootstrapped.
_bootstrap() protected ¶
_bootstrap( )
Initializes the environment and loads the CakePHP core.
Returns
Success.
_getShell() protected ¶
_getShell( string $shell )
Get shell to use, either plugin shell or application shell
All paths in the loaded shell paths are searched.
Parameters
- string $shell
- Optionally the name of a plugin
Returns
An object
Throws
_isAbsolutePath() protected ¶
_isAbsolutePath( string $path )
Checks whether the given path is absolute or relative.
Parameters
- string $path
- absolute or relative path.
Returns
_isWindowsPath() protected ¶
_isWindowsPath( string $path )
Checks whether the given path is Window OS path.
Parameters
- string $path
- absolute path.
Returns
_parsePaths() protected ¶
_parsePaths( array $args )
Parses out the paths from from the argv
Parameters
- array $args
- The argv to parse.
_stop() protected ¶
_stop( integer|string $status = 0 )
Stop execution of the current script
Parameters
- integer|string $status optional 0
- see http://php.net/exit for values
parseParams() public ¶
parseParams( array $args )
Parses command line options and extracts the directory paths from $params
Parameters
- array $args
- Parameters to parse
run() public static ¶
run( array $argv )
Run the dispatcher
Parameters
- array $argv
- The argv from PHP
setErrorHandlers() public ¶
setErrorHandlers( )
Set the error/exception handlers for the console
based on the Error.consoleHandler, and Exception.consoleHandler values
if they are set. If they are not set, the default ConsoleErrorHandler will be
used.
shiftArgs() public ¶
shiftArgs( )
Removes first argument and shifts other arguments up
Returns
Null if there are no arguments otherwise the shifted argument