Property | Type | Description | |
---|---|---|---|
$canBeRunMultipleTimes | |||
$config | |||
$envArgName | |||
$hiddenInList | |||
$interactive | boolean | ||
$local | |||
$localProject | |||
$output | Symfony\Component\Console\Output\OutputInterface | null | ||
$runningViaMulti | |||
$stdErr | Symfony\Component\Console\Output\OutputInterface | null |
Method | Description | |
---|---|---|
__construct ( $name = null ) | ||
canBeRunMultipleTimes ( ) | ||
getCurrentEnvironment ( Platformsh\Client\Model\Project $expectedProject = null, boolean | null $refresh = null ) : Platformsh\Client\Model\Environment | false | Get the current environment if the user is in a project directory. | |
getCurrentProject ( ) : Platformsh\Client\Model\Project | false | Get the current project if the user is in a project directory. | |
getHelper ( $name ) | ||
getProcessedHelp ( ) | ||
getProjectRoot ( ) : string | false | ||
getSynopsis ( $short = false ) | ||
getVisibleAliases ( ) : array | Get aliases that should be visible in help. | |
isHiddenInList ( ) | ||
isLocal ( ) : boolean | Is this a local command? (if it does not make API requests) | |
login ( ) | Log in the user. | |
setRunningViaMulti ( $runningViaMulti = true ) | ||
updateDrushAliases ( |
Update the user's local Drush aliases. |
Method | Description | |
---|---|---|
addAppOption ( ) : |
Add the --app option. | |
addEnvironmentOption ( ) : |
Add the --environment option. | |
addNoWaitOption ( string $description = 'Do not wait for the operation to complete' ) : |
Add the --no-wait option. | |
addProjectOption ( ) : |
Add the --project and --host options. | |
api ( ) : |
Set up the API object. | |
checkUpdates ( boolean $reset = false ) | Check for updates. | |
debug ( string $message ) | Print a message if debug output is enabled. | |
getHomeDir ( ) : string | ||
getSelectedEnvironment ( ) : Platformsh\Client\Model\Environment | Get the environment selected by the user. | |
getSelectedProject ( ) : Platformsh\Client\Model\Project | Get the project selected by the user. | |
getSessionsDir ( ) : string | ||
hasSelectedEnvironment ( ) : boolean | Check whether a single environment is selected. | |
hasSelectedProject ( ) : boolean | Check whether a project is selected. | |
initialize ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) | ||
interact ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) | ||
isTerminal ( Symfony\Component\Console\Output\OutputInterface $output ) : boolean | Detect automatically whether the output is a TTY terminal. | |
parseProjectId ( string $url ) : array | Parse the project ID and possibly other details from a provided URL. | |
promptLegacyMigrate ( ) | Prompt the user to migrate from the legacy project file structure. | |
rebuildWarning ( ) | Warn the user that the remote environment needs rebuilding. | |
runOtherCommand ( string $name, array $arguments = [], Symfony\Component\Console\Output\OutputInterface $output = null ) : integer | Run another CLI command. | |
selectApp ( Symfony\Component\Console\Input\InputInterface $input, callable $filter = null ) : string | null | Find the name of the app the user wants to use for an SSH command. | |
selectEnvironment ( string | null $environmentId = null ) : Platformsh\Client\Model\Environment | Select the current environment for the user. | |
selectProject ( string $projectId = null, string $host = null ) : Platformsh\Client\Model\Project | Select the project for the user, based on input or the environment. | |
selectedProjectIsCurrent ( ) : boolean | ||
setHiddenAliases ( array $hiddenAliases ) : |
Add aliases that should be hidden from help. | |
setProjectRoot ( string $root ) | ||
validateInput ( Symfony\Component\Console\Input\InputInterface $input, boolean $envNotRequired = false ) |
protected addAppOption ( ) : |
||
return |
protected addEnvironmentOption ( ) : |
||
return |
protected addNoWaitOption ( string $description = 'Do not wait for the operation to complete' ) : |
||
$description | string | |
return |
protected addProjectOption ( ) : |
||
return |
protected checkUpdates ( boolean $reset = false ) | ||
$reset | boolean |
public getCurrentEnvironment ( Platformsh\Client\Model\Project $expectedProject = null, boolean | null $refresh = null ) : Platformsh\Client\Model\Environment | false | ||
$expectedProject | Platformsh\Client\Model\Project | The expected project. |
$refresh | boolean | null | Whether to refresh the environments or projects cache. |
return | Platformsh\Client\Model\Environment | false | The current environment. |
public getCurrentProject ( ) : Platformsh\Client\Model\Project | false | ||
return | Platformsh\Client\Model\Project | false | The current project |
public getProcessedHelp ( ) |
protected getSelectedEnvironment ( ) : Platformsh\Client\Model\Environment | ||
return | Platformsh\Client\Model\Environment |
protected getSelectedProject ( ) : Platformsh\Client\Model\Project | ||
return | Platformsh\Client\Model\Project |
public getVisibleAliases ( ) : array | ||
return | array |
protected hasSelectedEnvironment ( ) : boolean | ||
return | boolean |
protected hasSelectedProject ( ) : boolean | ||
return | boolean |
protected initialize ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) | ||
$input | Symfony\Component\Console\Input\InputInterface | |
$output | Symfony\Component\Console\Output\OutputInterface |
protected interact ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) | ||
$input | Symfony\Component\Console\Input\InputInterface | |
$output | Symfony\Component\Console\Output\OutputInterface |
protected isTerminal ( Symfony\Component\Console\Output\OutputInterface $output ) : boolean | ||
$output | Symfony\Component\Console\Output\OutputInterface | |
return | boolean |
protected parseProjectId ( string $url ) : array | ||
$url | string | A web UI, API, or public URL of the project. |
return | array | An array of containing at least a 'projectId'. Keys 'host', 'environmentId', and 'appId' will be either null or strings. |
protected promptLegacyMigrate ( ) |
protected rebuildWarning ( ) |
protected runOtherCommand ( string $name, array $arguments = [], Symfony\Component\Console\Output\OutputInterface $output = null ) : integer | ||
$name | string | The name of the other command. |
$arguments | array | Arguments for the other command. |
$output | Symfony\Component\Console\Output\OutputInterface | The output for the other command. Defaults to the current output. |
return | integer |
protected selectApp ( Symfony\Component\Console\Input\InputInterface $input, callable $filter = null ) : string | null | ||
$input | Symfony\Component\Console\Input\InputInterface | The user input object. |
$filter | callable | A filter callback that takes one argument: a LocalApplication object. |
return | string | null | The application name, or null if it could not be found. |
protected selectEnvironment ( string | null $environmentId = null ) : Platformsh\Client\Model\Environment | ||
$environmentId | string | null | The environment ID specified by the user, or null to auto-detect the environment. |
return | Platformsh\Client\Model\Environment |
protected selectProject ( string $projectId = null, string $host = null ) : Platformsh\Client\Model\Project | ||
$projectId | string | |
$host | string | |
return | Platformsh\Client\Model\Project |
protected selectedProjectIsCurrent ( ) : boolean | ||
return | boolean |
protected setHiddenAliases ( array $hiddenAliases ) : |
||
$hiddenAliases | array | |
return |
public updateDrushAliases ( |
||
$event |
protected validateInput ( Symfony\Component\Console\Input\InputInterface $input, boolean $envNotRequired = false ) | ||
$input | Symfony\Component\Console\Input\InputInterface | |
$envNotRequired | boolean |
protected static CliConfig,Platformsh\Cli $config | ||
return |
protected LocalProject,Platformsh\Cli\Local|null $localProject | ||
return |
protected OutputInterface,Symfony\Component\Console\Output|null $output | ||
return | Symfony\Component\Console\Output\OutputInterface | null |
protected OutputInterface,Symfony\Component\Console\Output|null $stdErr | ||
return | Symfony\Component\Console\Output\OutputInterface | null |