Action to create a Unit Test

Clear the console

Constructs this Shell instance.

Creates the proper controller plural name for the specified controller class name

Creates the proper controller path for the specified controller class name

Creates a file at given path

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

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');

Display the help in the correct format

Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.

Displays a formatted error message and exits the application with status code 1

Overload get for lazy building of tasks

Prompts the user for input, and returns it.

Gets the option parser instance and configures it. By overriding this method you can configure the ConsoleOptionParser before returning it.

Check to see if this shell has a callable method by the given name.

Check to see if this shell has a task with the provided name.

Outputs a series of minus characters to the standard output, acts as a visual separator.

Prompts the user for input, and returns it.

Initializes the Shell acts as constructor for subclasses allows configuration of tasks prior to shell execution

If $uses = true Loads AppModel file and constructs AppModel class makes $this->AppModel available to subclasses If public $uses is an array of models will load those models

Loads tasks defined in public $tasks

Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Creates the proper underscored model key for associations

Creates the proper model camelized name (singularized) for the specified name

Creates the proper model name from a foreign key

Returns a single or multiple linefeeds sequences.

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.

Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.

Creates the plural human name used in views

Creates the plural name for views

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

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.

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Makes absolute file path easier to read

Creates the singular human name used in views

creates the singular name for use in views.

Stop execution of the current script. Wraps exit() making testing easier.

Object-to-string conversion. Each class can override this method as necessary.

Displays a header for the shell

Wrap a block of text. Allows you to set the width, and indenting on a block of text.

Options

• width The width to wrap to. Defaults to 72
• wordWrap Only wrap on words breaks (spaces) Defaults to true.
• indent Indent the text with the string provided. Defaults to null.