ShellCommandException ​
- Type
- Final Class
- Namespace
- craft\errors
- Inherits
- craft\errors\ShellCommandException » yii\base\Exception » Exception
- Since
- 3.0.0
ShellCommandException represents an exception caused by setting an invalid license key on a plugin.
Public Properties ​
| Property | Description |
|---|---|
| command | string – The command that was executed |
| error | string, null – The command’s error output |
| exitCode | integer – The command’s exit code |
command ​
- Type
- string
- Default value
null
The command that was executed
error ​
The command’s error output
exitCode ​
- Type
- integer
- Default value
null
The command’s exit code
Public Methods ​
| Method | Description |
|---|---|
| __construct() | Constructor. |
| createFromCommand() | Creates a ShellCommandException from a \mikehaertl\shellcommand\Command object |
| getName() |
__construct() ​
Constructor.
Arguments ​
$command(string) – The command that was executed$exitCode(integer) – The command’s exit code$error(string, null) – The command’s error output$message(string, null) – The error message$code(integer) – The error code
createFromCommand() ​
Creates a ShellCommandException from a \mikehaertl\shellcommand\Command object
Arguments ​
$command(\mikehaertl\shellcommand\Command) – The failed Command object
Returns ​
static, false
getName() ​
Returns ​
string – The user-friendly name of this exception