| Property | Type | Description | |
|---|---|---|---|
| $cloud | |||
| $envId | integer | The identifier of the environment | |
| $group | string | The group of client environment properties | |
| $platform | string | The name of the cloud platform |
| Method | Description | |
|---|---|---|
| __construct ( integer $envId, string $platform, string $group = null ) | Constructor | |
| getLastErrorMessage ( ) : string | Returns last error message | |
| isPendingSuspend ( ) : boolean | Whether current platform has suspension errors | |
| isSuspended ( ) : boolean | Whether current platform is suspended | |
| isSuspensionException ( Exception $e ) : boolean | Checks whether it is the cloud platform suspension exception | |
| registerError ( string $errorMessage ) | Registers suspension error and suspends cloud platform if the timeout is reached | |
| resume ( ) | Resumes cloud platform | |
| suspend ( ) | Suspends the cloud platform |
| Method | Description | |
|---|---|---|
|
initProp ( string $name, string $value = null ) : |
Initializes environment property |
| public getLastErrorMessage ( ) : string | ||
| return | string | Returns last error message |
| public isPendingSuspend ( ) : boolean | ||
| return | boolean | Returns true if the cloud platform is in the progress of the suspension due to ongoing errors |
| public isSuspended ( ) : boolean | ||
| return | boolean | Returns true if cloud platform is suspended |
| public static isSuspensionException ( Exception $e ) : boolean | ||
| $e | Exception | |
| return | boolean | Returns true if the exception is the suspension type |
| public registerError ( string $errorMessage ) | ||
| $errorMessage | string | The error message |
| public string $group | ||
| return | string | |
