Method | Description | |
---|---|---|
getCommand ( string $name ) : |
Returns the command for a given name. | |
getCommands ( ) : |
Returns all registered commands. | |
getConfig ( ) : |
Returns the application configuration. | |
getDefaultCommands ( ) : |
Returns the commands that should be executed if no explicit command is passed. | |
getGlobalArgsFormat ( ) : |
Returns the global arguments format of the application. | |
getNamedCommands ( ) : |
Returns the commands that are not anonymous. | |
hasCommand ( string $name ) : boolean | Returns whether the application has a command with a given name. | |
hasCommands ( ) : boolean | Returns whether the application has any registered commands. | |
hasDefaultCommands ( ) : boolean | Returns whether the application has any default commands. | |
hasNamedCommands ( ) : boolean | Returns whether the application has any commands that are not anonymous. | |
resolveCommand ( Webmozart\Console\Api\Args\RawArgs $args ) : |
Returns the command to execute for the given console arguments. | |
run ( Webmozart\Console\Api\Args\RawArgs $args = null, Webmozart\Console\Api\IO\InputStream $inputStream = null, Webmozart\Console\Api\IO\OutputStream $outputStream = null, Webmozart\Console\Api\IO\OutputStream $errorStream = null ) : integer | Executes the command. |
public getCommand ( string $name ) : |
||
$name | string | The name of the command. |
return | The command. |
public getCommands ( ) : |
||
return | The commands. |
public getConfig ( ) : |
||
return | The application configuration. |
public getDefaultCommands ( ) : |
||
return | The default commands. |
public getGlobalArgsFormat ( ) : |
||
return | The global arguments format. |
public getNamedCommands ( ) : |
||
return | The named commands. |
public hasCommand ( string $name ) : boolean | ||
$name | string | The name of the command. |
return | boolean | Returns `true` if the command with the given name exists and `false` otherwise. |
public hasCommands ( ) : boolean | ||
return | boolean | Returns `true` if the application has any commands and `false` otherwise. |
public hasDefaultCommands ( ) : boolean | ||
return | boolean | Returns `true` if the application has default commands and `false` otherwise. |
public hasNamedCommands ( ) : boolean | ||
return | boolean | Returns `true` if the application has named commands and `false` otherwise. |
public resolveCommand ( Webmozart\Console\Api\Args\RawArgs $args ) : |
||
$args | Webmozart\Console\Api\Args\RawArgs | The console arguments. |
return | The command to execute. |
public run ( Webmozart\Console\Api\Args\RawArgs $args = null, Webmozart\Console\Api\IO\InputStream $inputStream = null, Webmozart\Console\Api\IO\OutputStream $outputStream = null, Webmozart\Console\Api\IO\OutputStream $errorStream = null ) : integer | ||
$args | Webmozart\Console\Api\Args\RawArgs | The console arguments. If not given, the arguments passed to the PHP process are used. |
$inputStream | Webmozart\Console\Api\IO\InputStream | The standard input. If not given, the application reads from the standard input of the PHP process. |
$outputStream | Webmozart\Console\Api\IO\OutputStream | The standard output. If not given, the application prints to the standard output of the PHP process. |
$errorStream | Webmozart\Console\Api\IO\OutputStream | The error output. If not given, the application prints to the error output of the PHP process. |
return | integer | The exit status. |