From 1d2f862d98f5cc75fbafa992afa8b7bd190f3778 Mon Sep 17 00:00:00 2001 From: Yuri Kuznetsov Date: Fri, 24 Jun 2022 11:13:02 +0300 Subject: [PATCH] phpdoc fixes --- application/Espo/Controllers/Admin.php | 1 - .../Espo/Core/Authentication/Authentication.php | 1 - application/Espo/Core/Authentication/Logins/Hmac.php | 5 +++-- application/Espo/Core/Controllers/Base.php | 1 - application/Espo/Core/MassAction/Service.php | 10 +++++++++- .../Espo/Core/Utils/AdminNotificationManager.php | 1 - application/Espo/Core/Utils/TemplateFileManager.php | 3 --- application/Espo/Services/AdminNotifications.php | 2 -- application/Espo/Services/App.php | 1 - .../Espo/Tools/EntityManager/Hooks/BasePlusType.php | 1 - 10 files changed, 12 insertions(+), 14 deletions(-) diff --git a/application/Espo/Controllers/Admin.php b/application/Espo/Controllers/Admin.php index da305c21fb..6d7231137a 100644 --- a/application/Espo/Controllers/Admin.php +++ b/application/Espo/Controllers/Admin.php @@ -170,7 +170,6 @@ class Admin /** * @return array - * @throws \Espo\Core\Exceptions\Error */ public function actionAdminNotificationList(): array { diff --git a/application/Espo/Core/Authentication/Authentication.php b/application/Espo/Core/Authentication/Authentication.php index 4154864609..a86e7cb977 100644 --- a/application/Espo/Core/Authentication/Authentication.php +++ b/application/Espo/Core/Authentication/Authentication.php @@ -124,7 +124,6 @@ class Authentication * * Warning: This method can change the state of the object (by setting the `portal` prop.). * - * @throws Forbidden * @throws ServiceUnavailable */ public function login(AuthenticationData $data, Request $request, Response $response): Result diff --git a/application/Espo/Core/Authentication/Logins/Hmac.php b/application/Espo/Core/Authentication/Logins/Hmac.php index 08be09eef5..3607268f9e 100644 --- a/application/Espo/Core/Authentication/Logins/Hmac.php +++ b/application/Espo/Core/Authentication/Logins/Hmac.php @@ -36,10 +36,11 @@ use Espo\Core\{ Authentication\Login\Data, Authentication\Result, Authentication\Helper\UserFinder, - Exceptions\Error, Authentication\Result\FailReason, }; +use RuntimeException; + class Hmac implements Login { private $userFinder; @@ -71,7 +72,7 @@ class Hmac implements Login $secretKey = $this->apiKeyUtil->getSecretKeyForUserId($user->getId()); if (!$secretKey) { - throw new Error("No secret key for API user '" . $user->getId() . "'."); + throw new RuntimeException("No secret key for API user '" . $user->getId() . "'."); } $string = $request->getMethod() . ' ' . $request->getResourcePath(); diff --git a/application/Espo/Core/Controllers/Base.php b/application/Espo/Core/Controllers/Base.php index efc7494bbc..660ac781d9 100644 --- a/application/Espo/Core/Controllers/Base.php +++ b/application/Espo/Core/Controllers/Base.php @@ -164,7 +164,6 @@ abstract class Base } /** - * @throws Forbidden * @return void; * @deprecated */ diff --git a/application/Espo/Core/MassAction/Service.php b/application/Espo/Core/MassAction/Service.php index bb858a20b3..d372fe1c91 100644 --- a/application/Espo/Core/MassAction/Service.php +++ b/application/Espo/Core/MassAction/Service.php @@ -77,7 +77,7 @@ class Service * Perform a mass action. * * @throws Forbidden - * @throws BadRequest + * @throws NotFound */ public function process( string $entityType, @@ -116,6 +116,10 @@ class Service ); } + /** + * @throws Forbidden + * @throws NotFound + */ public function getStatusData(string $id): stdClass { /** @var MassActionEntity|null $entity */ @@ -135,6 +139,10 @@ class Service ]; } + /** + * @throws Forbidden + * @throws NotFound + */ public function subscribeToNotificationOnSuccess(string $id): void { /** @var MassActionEntity|null $entity */ diff --git a/application/Espo/Core/Utils/AdminNotificationManager.php b/application/Espo/Core/Utils/AdminNotificationManager.php index 174010245a..56c91d8f7d 100644 --- a/application/Espo/Core/Utils/AdminNotificationManager.php +++ b/application/Espo/Core/Utils/AdminNotificationManager.php @@ -64,7 +64,6 @@ class AdminNotificationManager /** * @return array - * @throws \Espo\Core\Exceptions\Error */ public function getNotificationList(): array { diff --git a/application/Espo/Core/Utils/TemplateFileManager.php b/application/Espo/Core/Utils/TemplateFileManager.php index f1f6172bd9..3c321ddf00 100644 --- a/application/Espo/Core/Utils/TemplateFileManager.php +++ b/application/Espo/Core/Utils/TemplateFileManager.php @@ -54,9 +54,6 @@ class TemplateFileManager $this->fileReader = $fileReader; } - /** - * @throws Error - */ public function getTemplate( string $type, string $name, diff --git a/application/Espo/Services/AdminNotifications.php b/application/Espo/Services/AdminNotifications.php index 99465f4e9d..66778f9f9f 100644 --- a/application/Espo/Services/AdminNotifications.php +++ b/application/Espo/Services/AdminNotifications.php @@ -53,7 +53,6 @@ class AdminNotifications implements /** * Job for checking a new version of EspoCRM. - * @throws \Espo\Core\Exceptions\Error */ public function jobCheckNewVersion(): void { @@ -97,7 +96,6 @@ class AdminNotifications implements /** * Job for checking a new version of installed extensions. - * @throws \Espo\Core\Exceptions\Error */ public function jobCheckNewExtensionVersion(): void { diff --git a/application/Espo/Services/App.php b/application/Espo/Services/App.php index 751945370b..c3a4047b01 100644 --- a/application/Espo/Services/App.php +++ b/application/Espo/Services/App.php @@ -425,7 +425,6 @@ class App } /** - * @throws \Espo\Core\Exceptions\Error * @todo Remove in 7.2. Move to another place. CLI command. */ public function jobPopulateArrayValues(): void diff --git a/application/Espo/Tools/EntityManager/Hooks/BasePlusType.php b/application/Espo/Tools/EntityManager/Hooks/BasePlusType.php index 3d1d664c0a..d6e3bc8214 100644 --- a/application/Espo/Tools/EntityManager/Hooks/BasePlusType.php +++ b/application/Espo/Tools/EntityManager/Hooks/BasePlusType.php @@ -38,7 +38,6 @@ class BasePlusType implements Di\ConfigAware, Di\MetadataAware /** * @param array $params - * @throws \Espo\Core\Exceptions\Error */ public function afterCreate(string $name, $params): void {