Allows injecting mock IO into shells
Prints the currently installed version of CakePHP. Performs an internal dispatch to the CommandList Shell
__construct(array $args, bool $bootstrap, ?\Cake\Console\ConsoleIo $io)
Constructor
array
$args optional Argument array
bool
$bootstrap optional Initialize environment
\Cake\Console\ConsoleIo
$io optional ConsoleIo
_bootstrap()
Initializes the environment and loads the CakePHP core.
_createShell(string $className, string $shortName)
Injects mock and stub io components into the shell
string
$className Class name
string
$shortName Short name
\Cake\Console\Shell
_dispatch(array $extra)
Dispatch a request.
array
$extra optional Extra parameters that you can manually pass to the Shell to be dispatched. Built-in extra parameter is :
requested
: if used, will prevent the Shell welcome message to be displayedbool|int|null
Cake\Console\Exception\MissingShellMethodException
_handleAlias(string $shell)
If the input matches an alias, return the aliased shell name
string
$shell Optionally the name of a plugin or alias
string
Shell name with plugin prefix
_initEnvironment()
Defines current working environment.
Cake\Core\Exception\Exception
_shellExists(string $shell)
Check if a shell class exists for the given name.
string
$shell The shell name to look for.
string|null
Either the classname or null.
addShortPluginAliases()
For all loaded plugins, add a short alias
This permits a plugin which implements a shell of the same name to be accessed Using the shell name alone
array
the resultant list of aliases
alias(string $short, ?string $original)
Add an alias for a shell command.
Aliases allow you to call shells by alternate names. This is most useful when dealing with plugin shells that you want to have shorter names for.
If you re-use an alias the last alias set will be the one available.
Aliasing a shell named ClassName:
$this->alias('alias', 'ClassName');
Getting the original name for a given alias:
$this->alias('alias');
string
$short The new short name for the shell.
string|null
$original optional The original full name for the shell.
string|null
The aliased class name, or null if the alias does not exist
dispatch(array $extra)
Dispatches a CLI request
Converts a shell command result into an exit code. Null/True are treated as success. All other return values are an error.
array
$extra optional Extra parameters that you can manually pass to the Shell to be dispatched. Built-in extra parameter is :
requested
: if used, will prevent the Shell welcome message to be displayedint
The CLI command exit code. 0 is success.
findShell(string $shell)
Get shell to use, either plugin shell or application shell
All paths in the loaded shell paths are searched, handles alias dereferencing
string
$shell Optionally the name of a plugin
\Cake\Console\Shell
A shell instance.
Cake\Console\Exception\MissingShellException
help()
Shows console help. Performs an internal dispatch to the CommandList Shell
resetAliases()
Clear any aliases that have been set.
run(array $argv, array $extra)
Run the dispatcher
array
$argv The argv from PHP
array
$extra optional Extra parameters
int
The exit code of the shell process.
shiftArgs()
Removes first argument and shifts other arguments up
mixed
Null if there are no arguments otherwise the shifted argument
version()
Prints the currently installed version of CakePHP. Performs an internal dispatch to the CommandList Shell
List of connected aliases.
array
\Cake\Console\ConsoleIo
Contains arguments parsed from the command line.
array
© 2005–present 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/4.1/class-Cake.TestSuite.LegacyShellDispatcher.html