W3cubDocs

/CakePHP 3.8

Class LegacyShellDispatcher

Allows injecting mock IO into shells

Cake\Console\ShellDispatcher
Extended by Cake\TestSuite\LegacyShellDispatcher

Properties summary

Inherited Properties

Method Summary

Method Detail

__construct()source public

__construct( array $args = [] , boolean $bootstrap = true , Cake\Console\ConsoleIo $io = null )

Constructor

Parameters

array $args optional []
Argument array
boolean $bootstrap optional true
Initialize environment
Cake\Console\ConsoleIo $io optional null
ConsoleIo

Overrides

Cake\Console\ShellDispatcher::__construct()

_createShell()source protected

_createShell( string $className , string $shortName )

Injects mock and stub io components into the shell

Parameters

string $className
Class name
string $shortName
Short name

Returns

Cake\Console\Shell

Overrides

Cake\Console\ShellDispatcher::_createShell()

Methods inherited from Cake\Console\ShellDispatcher

_bootstrap()source protected

_bootstrap( )

Initializes the environment and loads the CakePHP core.

Returns

boolean
Success.

_dispatch()source protected

_dispatch( array $extra = [] )

Dispatch a request.

Parameters

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 displayed

Returns

boolean|integer|null

Throws

Cake\Console\Exception\MissingShellMethodException

_handleAlias()source protected

_handleAlias( string $shell )

If the input matches an alias, return the aliased shell name

Parameters

string $shell
Optionally the name of a plugin or alias

Returns

string
Shell name with plugin prefix

_initEnvironment()source protected

_initEnvironment( )

Defines current working environment.

Throws

Cake\Core\Exception\Exception

_shellExists()source protected

_shellExists( string $shell )

Check if a shell class exists for the given name.

Parameters

string $shell
The shell name to look for.

Returns

string|boolean
Either the classname or false.

addShortPluginAliases()source public

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

Returns

array
the resultant list of aliases

alias()source public static

alias( string $short , string|null $original = null )

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.

Usage

Aliasing a shell named ClassName:

$this->alias('alias', 'ClassName');

Getting the original name for a given alias:

$this->alias('alias');

Parameters

string $short
The new short name for the shell.
string|null $original optional null
The original full name for the shell.

Returns

string|false
The aliased class name, or false if the alias does not exist

dispatch()source public

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.

Parameters

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 displayed

Returns

integer
The cli command exit code. 0 is success.

findShell()source public

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

Parameters

string $shell
Optionally the name of a plugin

Returns

Cake\Console\Shell
A shell instance.

Throws

Cake\Console\Exception\MissingShellException
when errors are encountered.

help()source public

help( )

Shows console help. Performs an internal dispatch to the CommandList Shell

resetAliases()source public static

resetAliases( )

Clear any aliases that have been set.

run()source public static

run( array $argv , array $extra = [] )

Run the dispatcher

Parameters

array $argv
The argv from PHP
array $extra optional []
Extra parameters

Returns

integer
The exit code of the shell process.

shiftArgs()source public

shiftArgs( )

Removes first argument and shifts other arguments up

Returns

mixed
Null if there are no arguments otherwise the shifted argument

version()source public

version( )

Prints the currently installed version of CakePHP. Performs an internal dispatch to the CommandList Shell

Properties detail

© 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/3.8/class-Cake.TestSuite.LegacyShellDispatcher.html