| Property | Type | Description | |
|---|---|---|---|
| $command | Name of the command to be run as it will be used on server | ||
| $unavailable_commands | A hash of commands which do not work using Terminus. The key is the native command, and the value is the Terminus equivalent which is optional. | ||
| $valid_frameworks | array |
| Method | Description | |
|---|---|---|
| executeCommand ( array $command_args ) : string | Execute the command remotely | |
| prepareEnvironment ( string $site_env_id ) | Define the environment and site properties | |
| validateCommand ( array $command ) : boolean | Validates the command as available | |
| validateConnectionMode ( string $mode ) | Validates that the environment is using the correct connection mode | |
| validateEnvironment ( Site $site, Environment $environment ) | Validates that the environment's connection mode is appropriately set | |
| validateFramework ( string $framework ) | Validates the framework being used |
| Method | Description | |
|---|---|---|
| getCommandLine ( string $command_args ) : string | Gets the command-line args |
| protected executeCommand ( array $command_args ) : string | ||
| $command_args | array | |
| return | string | |
| protected prepareEnvironment ( string $site_env_id ) | ||
| $site_env_id | string | The site/env to retrieve in |
| protected validateCommand ( array $command ) : boolean | ||
| $command | array | |
| return | boolean | |
| protected validateConnectionMode ( string $mode ) | ||
| $mode | string | |
| protected validateEnvironment ( Site $site, Environment $environment ) | ||
| $site | Site | |
| $environment | Environment | |
| protected validateFramework ( string $framework ) | ||
| $framework | string | |
| protected $command |
