From 1a97a69957eef763ae9200c70019c50a41d04f76 Mon Sep 17 00:00:00 2001 From: Roussetos Karafyllakis <35-roussks@users.noreply.git.upmind.io> Date: Mon, 13 May 2024 16:32:34 +0100 Subject: [PATCH] Remove not used import and update docblocks with relevant throws --- src/Data/CreateResult.php | 1 - src/Data/LoginResult.php | 1 - src/Providers/Example/Provider.php | 10 ++-- .../Marketgoo/Exceptions/OperationFailed.php | 1 - src/Providers/Marketgoo/Provider.php | 48 +++++++++++++++++++ 5 files changed, 55 insertions(+), 6 deletions(-) diff --git a/src/Data/CreateResult.php b/src/Data/CreateResult.php index bb263d8..4fe0e91 100644 --- a/src/Data/CreateResult.php +++ b/src/Data/CreateResult.php @@ -4,7 +4,6 @@ namespace Upmind\ProvisionProviders\Seo\Data; -use Upmind\ProvisionBase\Provider\DataSet\DataSet; use Upmind\ProvisionBase\Provider\DataSet\ResultData; use Upmind\ProvisionBase\Provider\DataSet\Rules; diff --git a/src/Data/LoginResult.php b/src/Data/LoginResult.php index ffb692e..97d3fad 100644 --- a/src/Data/LoginResult.php +++ b/src/Data/LoginResult.php @@ -4,7 +4,6 @@ namespace Upmind\ProvisionProviders\Seo\Data; -use Upmind\ProvisionBase\Provider\DataSet\DataSet; use Upmind\ProvisionBase\Provider\DataSet\ResultData; use Upmind\ProvisionBase\Provider\DataSet\Rules; diff --git a/src/Providers/Example/Provider.php b/src/Providers/Example/Provider.php index db24ff2..6b2da77 100644 --- a/src/Providers/Example/Provider.php +++ b/src/Providers/Example/Provider.php @@ -22,7 +22,7 @@ class Provider extends Category implements ProviderInterface { protected Configuration $configuration; - protected Client $client; + protected Client|null $client = null; public function __construct(Configuration $configuration) { @@ -42,18 +42,22 @@ public static function aboutProvider(): AboutData /** * @inheritDoc + * + * @throws \Upmind\ProvisionBase\Exception\ProvisionFunctionError */ public function create(CreateParams $params): CreateResult { - throw $this->errorResult('Not Implemented'); + $this->errorResult('Not Implemented'); } /** * @inheritDoc + * + * @throws \Upmind\ProvisionBase\Exception\ProvisionFunctionError */ public function changePackage(ChangePackageParams $params): EmptyResult { - throw $this->errorResult('Not Implemented'); + $this->errorResult('Not Implemented'); } /** diff --git a/src/Providers/Marketgoo/Exceptions/OperationFailed.php b/src/Providers/Marketgoo/Exceptions/OperationFailed.php index 98e4177..19ce6f6 100644 --- a/src/Providers/Marketgoo/Exceptions/OperationFailed.php +++ b/src/Providers/Marketgoo/Exceptions/OperationFailed.php @@ -4,7 +4,6 @@ namespace Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions; -use Throwable; use Upmind\ProvisionBase\Exception\ProvisionFunctionError; /** diff --git a/src/Providers/Marketgoo/Provider.php b/src/Providers/Marketgoo/Provider.php index 012a721..b8e93a4 100644 --- a/src/Providers/Marketgoo/Provider.php +++ b/src/Providers/Marketgoo/Provider.php @@ -42,6 +42,10 @@ public function __construct(Configuration $configuration) $this->configuration = $configuration; } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ public function create(CreateParams $params): CreateResult { $domainName = $params->domain; @@ -61,11 +65,19 @@ public function create(CreateParams $params): CreateResult ->setMessage('Account created'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ public function login(AccountIdentifierParams $params): LoginResult { return LoginResult::create()->setUrl($this->getLoginUrl($params->username)); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ public function changePackage(ChangePackageParams $params): EmptyResult { try { @@ -81,6 +93,10 @@ public function changePackage(ChangePackageParams $params): EmptyResult return EmptyResult::create()->setMessage('Account updated'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ public function suspend(AccountIdentifierParams $params): EmptyResult { try { @@ -96,6 +112,10 @@ public function suspend(AccountIdentifierParams $params): EmptyResult return EmptyResult::create()->setMessage('Account suspended'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ public function unsuspend(AccountIdentifierParams $params): EmptyResult { try { @@ -111,6 +131,10 @@ public function unsuspend(AccountIdentifierParams $params): EmptyResult return EmptyResult::create()->setMessage('Account unsuspended'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ public function terminate(AccountIdentifierParams $params): EmptyResult { $this->deleteAccount($params->username); @@ -133,6 +157,10 @@ protected function client(): Client ]); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ protected function getLoginUrl(string $username): string { // get 5-minute ttl sso link @@ -141,6 +169,10 @@ protected function getLoginUrl(string $username): string return $handler->getLoginUrl(); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ private function createAccount( string $domainName, string $productKey, @@ -167,6 +199,10 @@ private function createAccount( return $handler->getAccountIdentifier('create'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ private function upgradeAccount(string $accountId, string $productKey): void { $response = $this->client()->patch("accounts/{$accountId}/upgrade", [ @@ -185,6 +221,10 @@ private function upgradeAccount(string $accountId, string $productKey): void $handler->assertSuccess('upgrade'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ private function suspendAccount(string $accountId): void { $response = $this->client()->patch("accounts/{$accountId}/suspend"); @@ -192,6 +232,10 @@ private function suspendAccount(string $accountId): void $handler->assertSuccess('suspend'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ private function resumeAccount(string $accountId): void { $response = $this->client()->patch("accounts/{$accountId}/resume"); @@ -199,6 +243,10 @@ private function resumeAccount(string $accountId): void $handler->assertSuccess('resume'); } + /** + * @throws \GuzzleHttp\Exception\GuzzleException + * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed + */ private function deleteAccount(string $accountId): void { $response = $this->client()->delete("accounts/{$accountId}");