Method | Description | |
---|---|---|
getSubCommandDescription ( string $controllerCommandName ) : string | Returns a piece of description for the specific task the plugin solves for the specified command | |
getSubCommandShortDescription ( string $controllerCommandName ) : string | Returns a short description for the specific task the plugin solves for the specified command | |
invokeSubCommand ( string $controllerCommandName, |
A method which runs the task implemented by the plugin for the given command |
public static getSubCommandDescription ( string $controllerCommandName ) : string | ||
$controllerCommandName | string | Name of the command in question, for example "repair" |
return | string | A piece of text to be included in the overall description of the node:xy command |
public static getSubCommandShortDescription ( string $controllerCommandName ) : string | ||
$controllerCommandName | string | Name of the command in question, for example "repair" |
return | string | A brief description / summary for the task this plugin is going to do |
public invokeSubCommand ( string $controllerCommandName, |
||
$controllerCommandName | string | Name of the command in question, for example "repair" |
$output | An instance of ConsoleOutput which can be used for output or dialogues | |
$nodeType | Only handle this node type (if specified) | |
$workspaceName | string | Only handle this workspace (if specified) |
$dryRun | boolean | If TRUE, don't do any changes, just simulate what you would do |
$cleanup | boolean | If FALSE, cleanup tasks are skipped |
return | void |