Class CommandTask
Base class for Shell Command reflection.
- Cake\Console\Shell uses Cake\Log\LogTrait , Cake\Utility\MergeVariablesTrait , Cake\Datasource\ModelAwareTrait
-
Cake\Shell\Task\CommandTask
Inherited Properties
Method Summary
-
_appendShells() protected
Scan the provided paths for shells, and append them into $shellList -
_scanDir() protected
Scan a directory for .php files and return the class names that should be within them.
-
commands() public
Return a list of all commands -
getShell() public
Get Shell instance for the given command -
getShellList() public
Gets the shell command listing. -
options() public
Get Shell instance for the given command -
subCommands() public
Return a list of subcommands for a given command
Method Detail
_appendShells() protected ¶
_appendShells( string $type , array $shells , array $shellList )
Scan the provided paths for shells, and append them into $shellList
Parameters
- string $type
- The type of object.
- array $shells
- The shell name.
- array $shellList
- List of shells.
Returns
The updated $shellList
_scanDir() protected ¶
_scanDir( string $dir )
Scan a directory for .php files and return the class names that should be within them.
Parameters
- string $dir
- The directory to read.
Returns
The list of shell classnames based on conventions.
getShell() public ¶
getShell( mixed $commandName )
Get Shell instance for the given command
Parameters
- mixed $commandName
- The command you want.
Returns
options() public ¶
options( mixed $commandName )
Get Shell instance for the given command
Parameters
- mixed $commandName
- The command to get options for.
Returns
subCommands() public ¶
subCommands( string $commandName )
Return a list of subcommands for a given command
Parameters
- string $commandName
- The command you want subcommands from.
Returns
Methods inherited from Cake\Console\Shell
__construct() public ¶
__construct( Cake\Console\ConsoleIo $io = null )
Constructs this Shell instance.
Parameters
-
Cake\Console\ConsoleIo$io optional null - An io instance.
Link
__debugInfo() public ¶
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
Returns
__get() public ¶
__get( string $name )
Overload get for lazy building of tasks
Parameters
- string $name
- The task to get.
Returns
_displayHelp() protected ¶
_displayHelp( string $command )
Display the help in the correct format
Parameters
- string $command
- The command to get help for.
Returns
_stop() protected ¶
_stop( integer|string $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- integer|string $status optional 0
- see http://php.net/exit for values
createFile() public ¶
createFile( string $path , string $contents )
Creates a file at given path
Parameters
- string $path
- Where to put the file.
- string $contents
- Content to put in the file.
Returns
Success
Link
dispatchShell() public ¶
dispatchShell( )
Dispatch a command to another Shell. Similar to Object::requestAction() but intended for running shells from other shells.
Usage:
With a string command:
return $this->dispatchShell('schema create DbAcl');
Avoid using this form if you have string arguments, with spaces in them. The dispatched will be invoked incorrectly. Only use this form for simple command dispatching.
With an array command:
return $this->dispatchShell('schema', 'create', 'i18n', '--dry');
Returns
The return of the other shell.
Link
err() public ¶
err( string|array|null $message = null , integer $newlines = 1 )
Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.
Parameters
- string|array|null $message optional null
- A string or an array of strings to output
- integer $newlines optional 1
- Number of newlines to append
error() public ¶
error( string $title , string|null $message = null )
Displays a formatted error message and exits the application with status code 1
Parameters
- string $title
- Title of the error
- string|null $message optional null
- An optional error message
Link
getOptionParser() public ¶
getOptionParser( )
Gets the option parser instance and configures it.
By overriding this method you can configure the ConsoleOptionParser before returning it.
Returns
Link
hasMethod() public ¶
hasMethod( string $name )
Check to see if this shell has a callable method by the given name.
Parameters
- string $name
- The method name to check.
Returns
Link
hasTask() public ¶
hasTask( string $task )
Check to see if this shell has a task with the provided name.
Parameters
- string $task
- The task name to check.
Returns
Success
Link
hr() public ¶
hr( integer $newlines = 0 , integer $width = 63 )
Outputs a series of minus characters to the standard output, acts as a visual separator.
Parameters
- integer $newlines optional 0
- Number of newlines to pre- and append
- integer $width optional 63
- Width of the line, defaults to 63
Link
in() public ¶
in( string $prompt , string|array|null $options = null , string|null $default = null )
Prompts the user for input, and returns it.
Parameters
- string $prompt
- Prompt text.
- string|array|null $options optional null
- Array or string of options.
- string|null $default optional null
- Default input value.
Returns
Either the default value, or the user-provided input.
Link
initialize() public ¶
initialize( )
Initializes the Shell acts as constructor for subclasses allows configuration of tasks prior to shell execution
Link
io() public ¶
io( Cake\Console\ConsoleIo $io = null )
Get/Set the io object for this shell.
Parameters
-
Cake\Console\ConsoleIo$io optional null - The ConsoleIo object to use.
Returns
nl() public ¶
nl( integer $multiplier = 1 )
Returns a single or multiple linefeeds sequences.
Parameters
- integer $multiplier optional 1
- Number of times the linefeed sequence should be repeated
Returns
Link
out() public ¶
out( string|array|null $message = null , integer $newlines = 1 , integer $level = Cake\Shell\Task\Shell::NORMAL )
Outputs a single or multiple messages to stdout. If no parameters are passed outputs just a newline.
Output levels
There are 3 built-in output level. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE.
The verbose and quiet output levels, map to the verbose and quiet output switches
present in most shells. Using Shell::QUIET for a message means it will always display.
While using Shell::VERBOSE means it will only display when verbose output is toggled.
Parameters
- string|array|null $message optional null
- A string or an array of strings to output
- integer $newlines optional 1
- Number of newlines to append
- integer $level optional Cake\Shell\Task\Shell::NORMAL
- The message's output level, see above.
Returns
Returns the number of bytes returned from writing to stdout.
Link
param() public ¶
param( string $name )
Safely access the values in $this->params.
Parameters
- string $name
- The name of the parameter to get.
Returns
Value. Will return null if it doesn't exist.
quiet() public ¶
quiet( string|array $message , integer $newlines = 1 )
Output at all levels.
Parameters
- string|array $message
- A string or an array of strings to output
- integer $newlines optional 1
- Number of newlines to append
Returns
Returns the number of bytes returned from writing to stdout.
runCommand() public ¶
runCommand( array $argv , boolean $autoMethod = false )
Runs the Shell with the provided argv.
Delegates calls to Tasks and resolves methods inside the class. Commands are looked up with the following order:
- Method on the shell.
- Matching task name.
main()method.
If a shell implements a main() method, all missing method calls will be sent to
main() with the original method name in the argv.
For tasks to be invoked they must be exposed as subcommands. If you define any subcommands, you must define all the subcommands your shell needs, whether they be methods on this class or methods on tasks.
Parameters
- array $argv
- Array of arguments to run the shell with. This array should be missing the shell name.
- boolean $autoMethod optional false
Set to true to allow any public method to be called even if it was not defined as a subcommand. This is used by ShellDispatcher to make building simple shells easy.
Returns
Link
shortPath() public ¶
shortPath( string $file )
Makes absolute file path easier to read
Parameters
- string $file
- Absolute file path
Returns
short path
Link
startup() public ¶
startup( )
Starts up the Shell and displays the welcome message. Allows for checking and configuring prior to command or main execution
Override this method if you want to remove the welcome information, or otherwise modify the pre-command flow.
Link
verbose() public ¶
verbose( string|array $message , integer $newlines = 1 )
Output at the verbose level.
Parameters
- string|array $message
- A string or an array of strings to output
- integer $newlines optional 1
- Number of newlines to append
Returns
Returns the number of bytes returned from writing to stdout.
wrapText() public ¶
wrapText( string $text , integer|array $options = [] )
Wrap a block of text. Allows you to set the width, and indenting on a block of text.
Options
widthThe width to wrap to. Defaults to 72wordWrapOnly wrap on words breaks (spaces) Defaults to true.indentIndent the text with the string provided. Defaults to null.
Parameters
- string $text
- Text the text to format.
- integer|array $options optional []
- Array of options to use, or an integer to wrap the text to.
Returns
Wrapped / indented text
See
Link
Methods used from Cake\Log\LogTrait
log() public ¶
log( mixed $msg , integer|string $level = LogLevel::ERROR , string|array $context = [] )
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Parameters
- mixed $msg
- Log message.
- integer|string $level optional LogLevel::ERROR
- Error level.
- string|array $context optional []
- Additional log data relevant to this message.
Returns
Success of log write.
Methods used from Cake\Utility\MergeVariablesTrait
_mergeProperty() protected ¶
_mergeProperty( string $property , array $parentClasses , array $options )
Merge a single property with the values declared in all parent classes.
Parameters
- string $property
- The name of the property being merged.
- array $parentClasses
- An array of classes you want to merge with.
- array $options
- Options for merging the property, see _mergeVars()
_mergePropertyData() protected ¶
_mergePropertyData( array $current , array $parent , boolean $isAssoc )
Merge each of the keys in a property together.
Parameters
- array $current
- The current merged value.
- array $parent
- The parent class' value.
- boolean $isAssoc
- Whether or not the merging should be done in associative mode.
Returns
The updated value.
_mergeVars() protected ¶
_mergeVars( array $properties , array $options = [] )
Merge the list of $properties with all parent classes of the current class.
Options:
associative- A list of properties that should be treated as associative arrays. Properties in this list will be passed through Hash::normalize() before merging.
Parameters
- array $properties
- An array of properties and the merge strategy for them.
- array $options optional []
- The options to use when merging properties.
Methods used from Cake\Datasource\ModelAwareTrait
_setModelClass() protected ¶
_setModelClass( string $name )
Set the modelClass and modelKey properties based on conventions.
If the properties are already set they will not be overwritten
Parameters
- string $name
- Class name.
loadModel() public ¶
loadModel( string|null $modelClass = null , string $type = 'Table' )
Loads and constructs repository objects required by this object
Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.
If a repository provider does not return an object a MissingModelException will be thrown.
Parameters
- string|null $modelClass optional null
- Name of model class to load. Defaults to $this->modelClass
- string $type optional 'Table'
The type of repository to load. Defaults to 'Table' which delegates to Cake\ORM\TableRegistry.
Returns
The model instance created.
Throws
Cake\Datasource\Exception\MissingModelExceptionIf the model class cannot be found.
InvalidArgumentException
When using a type that has not been registered.
modelFactory() public ¶
modelFactory( string $type , callable $factory )
Register a callable to generate repositories of a given type.
Parameters
- string $type
- The name of the repository type the factory function is for.
- callable $factory
- The factory function used to create instances.