From 0c33ab925541ca1cc1ab68c1bfaf92fe97ba58ae Mon Sep 17 00:00:00 2001 From: Dimitri BOUTEILLE Date: Tue, 10 Sep 2024 14:30:48 +0200 Subject: [PATCH 01/11] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface --- .../Magento/Framework/Message/Manager.php | 105 ++---------------- .../Framework/Message/ManagerInterface.php | 21 ++-- 2 files changed, 22 insertions(+), 104 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index d71e196deea88..476ece21b540e 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -112,10 +112,6 @@ protected function prepareGroup($group) /** * @inheritdoc - * - * @param bool $clear - * @param string|null $group - * @return Collection */ public function getMessages($clear = false, $group = null) { @@ -135,10 +131,6 @@ public function getMessages($clear = false, $group = null) /** * @inheritdoc - * - * @param MessageInterface $message - * @param string|null $group - * @return $this */ public function addMessage(MessageInterface $message, $group = null) { @@ -150,10 +142,6 @@ public function addMessage(MessageInterface $message, $group = null) /** * @inheritdoc - * - * @param MessageInterface[] $messages - * @param string|null $group - * @return $this */ public function addMessages(array $messages, $group = null) { @@ -167,10 +155,6 @@ public function addMessages(array $messages, $group = null) /** * @inheritdoc - * - * @param string $message - * @param string|null $group - * @return $this */ public function addError($message, $group = null) { @@ -180,10 +164,6 @@ public function addError($message, $group = null) /** * @inheritdoc - * - * @param string $message - * @param string|null $group - * @return $this */ public function addWarning($message, $group = null) { @@ -193,10 +173,6 @@ public function addWarning($message, $group = null) /** * @inheritdoc - * - * @param string $message - * @param string|null $group - * @return $this */ public function addNotice($message, $group = null) { @@ -206,10 +182,6 @@ public function addNotice($message, $group = null) /** * @inheritdoc - * - * @param string $message - * @param string|null $group - * @return $this */ public function addSuccess($message, $group = null) { @@ -219,10 +191,6 @@ public function addSuccess($message, $group = null) /** * @inheritdoc - * - * @param MessageInterface[] $messages - * @param string|null $group - * @return $this */ public function addUniqueMessages(array $messages, $group = null) { @@ -239,11 +207,6 @@ public function addUniqueMessages(array $messages, $group = null) /** * @inheritdoc - * - * @param \Exception $exception - * @param string $alternativeText - * @param string $group - * @return $this */ public function addException(\Exception $exception, $alternativeText = null, $group = null) { @@ -282,11 +245,6 @@ public function hasMessages() /** * @inheritdoc - * - * @param \Exception $exception - * @param string $alternativeText - * @param string $group - * @return $this */ public function addExceptionMessage(\Exception $exception, $alternativeText = null, $group = null) { @@ -314,11 +272,7 @@ public function addExceptionMessage(\Exception $exception, $alternativeText = nu } /** - * Adds new error message - * - * @param string $message - * @param string|null $group - * @return ManagerInterface + * @inheritdoc */ public function addErrorMessage($message, $group = null) { @@ -331,11 +285,7 @@ public function addErrorMessage($message, $group = null) } /** - * Adds new warning message - * - * @param string $message - * @param string|null $group - * @return ManagerInterface + * @inheritdoc */ public function addWarningMessage($message, $group = null) { @@ -348,11 +298,7 @@ public function addWarningMessage($message, $group = null) } /** - * Adds new notice message - * - * @param string $message - * @param string|null $group - * @return ManagerInterface + * @inheritdoc */ public function addNoticeMessage($message, $group = null) { @@ -365,11 +311,7 @@ public function addNoticeMessage($message, $group = null) } /** - * Adds new success message - * - * @param string $message - * @param string|null $group - * @return ManagerInterface + * @inheritdoc */ public function addSuccessMessage($message, $group = null) { @@ -382,13 +324,7 @@ public function addSuccessMessage($message, $group = null) } /** - * Adds new complex error message - * - * @param string $identifier - * @param array $data - * @param string|null $group - * @return ManagerInterface - * @throws \InvalidArgumentException + * @inheritdoc */ public function addComplexErrorMessage($identifier, array $data = [], $group = null) { @@ -403,13 +339,7 @@ public function addComplexErrorMessage($identifier, array $data = [], $group = n } /** - * Adds new complex warning message - * - * @param string $identifier - * @param array $data - * @param string|null $group - * @return ManagerInterface - * @throws \InvalidArgumentException + * @inheritdoc */ public function addComplexWarningMessage($identifier, array $data = [], $group = null) { @@ -424,13 +354,7 @@ public function addComplexWarningMessage($identifier, array $data = [], $group = } /** - * Adds new complex notice message - * - * @param string $identifier - * @param array $data - * @param string|null $group - * @return ManagerInterface - * @throws \InvalidArgumentException + * @inheritdoc */ public function addComplexNoticeMessage($identifier, array $data = [], $group = null) { @@ -445,13 +369,7 @@ public function addComplexNoticeMessage($identifier, array $data = [], $group = } /** - * Adds new complex success message - * - * @param string $identifier - * @param array $data - * @param string|null $group - * @return ManagerInterface - * @throws \InvalidArgumentException + * @inheritdoc */ public function addComplexSuccessMessage($identifier, array $data = [], $group = null) { @@ -466,12 +384,7 @@ public function addComplexSuccessMessage($identifier, array $data = [], $group = } /** - * Creates identified message - * - * @param string $type - * @param string|null $identifier - * @return MessageInterface - * @throws \InvalidArgumentException + * @inheritdoc */ public function createMessage($type, $identifier = null) { diff --git a/lib/internal/Magento/Framework/Message/ManagerInterface.php b/lib/internal/Magento/Framework/Message/ManagerInterface.php index 29063a4deecbd..282163534adc6 100644 --- a/lib/internal/Magento/Framework/Message/ManagerInterface.php +++ b/lib/internal/Magento/Framework/Message/ManagerInterface.php @@ -50,7 +50,7 @@ public function addMessages(array $messages, $group = null); /** * Adds new error message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -61,7 +61,7 @@ public function addError($message, $group = null); /** * Adds new warning message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -72,7 +72,7 @@ public function addWarning($message, $group = null); /** * Adds new notice message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -83,7 +83,7 @@ public function addNotice($message, $group = null); /** * Adds new success message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -94,7 +94,7 @@ public function addSuccess($message, $group = null); /** * Adds new error message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface */ @@ -103,7 +103,7 @@ public function addErrorMessage($message, $group = null); /** * Adds new warning message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface */ @@ -112,7 +112,7 @@ public function addWarningMessage($message, $group = null); /** * Adds new notice message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface */ @@ -121,7 +121,7 @@ public function addNoticeMessage($message, $group = null); /** * Adds new success message * - * @param string $message + * @param string|\Magento\Framework\Phrase $message * @param string|null $group * @return ManagerInterface */ @@ -134,6 +134,7 @@ public function addSuccessMessage($message, $group = null); * @param array $data * @param string|null $group * @return ManagerInterface + * @throws \InvalidArgumentException */ public function addComplexErrorMessage($identifier, array $data = [], $group = null); @@ -144,6 +145,7 @@ public function addComplexErrorMessage($identifier, array $data = [], $group = n * @param array $data * @param string|null $group * @return ManagerInterface + * @throws \InvalidArgumentException */ public function addComplexWarningMessage($identifier, array $data = [], $group = null); @@ -154,6 +156,7 @@ public function addComplexWarningMessage($identifier, array $data = [], $group = * @param array $data * @param string|null $group * @return ManagerInterface + * @throws \InvalidArgumentException */ public function addComplexNoticeMessage($identifier, array $data = [], $group = null); @@ -164,6 +167,7 @@ public function addComplexNoticeMessage($identifier, array $data = [], $group = * @param array $data * @param string|null $group * @return ManagerInterface + * @throws \InvalidArgumentException */ public function addComplexSuccessMessage($identifier, array $data = [], $group = null); @@ -195,6 +199,7 @@ public function addException(\Exception $exception, $alternativeText = null, $gr * @param string|null $alternativeText * @param string|null $group * @return ManagerInterface + * @throws \InvalidArgumentException */ public function addExceptionMessage(\Exception $exception, $alternativeText = null, $group = null); From c8abbb92ac1b581d388ce1875e5e925b4249187f Mon Sep 17 00:00:00 2001 From: engcom-Charlie Date: Wed, 18 Dec 2024 17:05:53 +0530 Subject: [PATCH 02/11] Fixed static test failures --- .../Magento/Framework/Message/Manager.php | 19 +++++++++++++------ .../Framework/Message/ManagerInterface.php | 4 ++-- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 476ece21b540e..7353598cf7a12 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -1,7 +1,7 @@ session = $session; $this->messageFactory = $messageFactory; @@ -87,8 +95,7 @@ public function __construct( $this->eventManager = $eventManager; $this->logger = $logger; $this->defaultGroup = $defaultGroup; - $this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance() - ->get(ExceptionMessageLookupFactory::class); + $this->exceptionMessageFactory = $exceptionMessageFactory ?: $exceptionMessageLookupFactory; } /** diff --git a/lib/internal/Magento/Framework/Message/ManagerInterface.php b/lib/internal/Magento/Framework/Message/ManagerInterface.php index 282163534adc6..dbcfa8a82fed2 100644 --- a/lib/internal/Magento/Framework/Message/ManagerInterface.php +++ b/lib/internal/Magento/Framework/Message/ManagerInterface.php @@ -1,7 +1,7 @@ Date: Thu, 19 Dec 2024 14:49:43 +0530 Subject: [PATCH 03/11] Fixed static test failures --- lib/internal/Magento/Framework/Message/Manager.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 7353598cf7a12..5a79b886335f8 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -22,7 +22,7 @@ class Manager implements ManagerInterface /** * Default message group */ - protected const DEFAULT_GROUP = 'default'; + public const DEFAULT_GROUP = 'default'; /** * @var Session From 875fbfcffeeb4de2327b3849b919426b5c8f16cc Mon Sep 17 00:00:00 2001 From: engcom-Charlie Date: Thu, 19 Dec 2024 18:20:32 +0530 Subject: [PATCH 04/11] Fixed static test failures --- lib/internal/Magento/Framework/Message/Manager.php | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 5a79b886335f8..e7ca83672ec35 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -63,12 +63,7 @@ class Manager implements ManagerInterface * @var ExceptionMessageFactoryInterface */ private $exceptionMessageFactory; - - /** - * @var ExceptionMessageLookupFactory - */ - private $exceptionMessageLookupFactory; - + /** * @param Session $session * @param Factory $messageFactory From ab100b4d1a57988c0601118c38036afe77f1d8f6 Mon Sep 17 00:00:00 2001 From: engcom-Charlie Date: Mon, 23 Dec 2024 15:52:24 +0530 Subject: [PATCH 05/11] Fixed static test failures --- lib/internal/Magento/Framework/Message/Manager.php | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index e7ca83672ec35..02aa0ad6ab325 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -63,7 +63,7 @@ class Manager implements ManagerInterface * @var ExceptionMessageFactoryInterface */ private $exceptionMessageFactory; - + /** * @param Session $session * @param Factory $messageFactory @@ -90,7 +90,8 @@ public function __construct( $this->eventManager = $eventManager; $this->logger = $logger; $this->defaultGroup = $defaultGroup; - $this->exceptionMessageFactory = $exceptionMessageFactory ?: $exceptionMessageLookupFactory; + $this->exceptionMessageFactory = $exceptionMessageFactory ?: + ObjectManager::getInstance->get(ExceptionMessageLookupFactory::class); } /** From a56719972f1b2d55e43cfdeb797347eb3c22e5b8 Mon Sep 17 00:00:00 2001 From: engcom-Charlie Date: Mon, 23 Dec 2024 15:53:40 +0530 Subject: [PATCH 06/11] Fixed static test failures --- lib/internal/Magento/Framework/Message/Manager.php | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 02aa0ad6ab325..3646dece517d9 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -63,7 +63,6 @@ class Manager implements ManagerInterface * @var ExceptionMessageFactoryInterface */ private $exceptionMessageFactory; - /** * @param Session $session * @param Factory $messageFactory From 071dd7ed6af7db54a3196561378f12fef28180d3 Mon Sep 17 00:00:00 2001 From: engcom-Charlie Date: Tue, 31 Dec 2024 16:32:56 +0530 Subject: [PATCH 07/11] Fixed static test failures --- lib/internal/Magento/Framework/Message/Manager.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 3646dece517d9..2e0466f884c9b 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -63,6 +63,11 @@ class Manager implements ManagerInterface * @var ExceptionMessageFactoryInterface */ private $exceptionMessageFactory; + + /** + * @var ExceptionMessageLookupFactory + */ + private $exceptionMessageLookupFactory; /** * @param Session $session * @param Factory $messageFactory @@ -90,7 +95,8 @@ public function __construct( $this->logger = $logger; $this->defaultGroup = $defaultGroup; $this->exceptionMessageFactory = $exceptionMessageFactory ?: - ObjectManager::getInstance->get(ExceptionMessageLookupFactory::class); + ($this->exceptionMessageLookupFactory = $exceptionMessageLookupFactory ?: + ObjectManager::getInstance()->get(ExceptionMessageLookupFactory::class)); } /** From dcf084d8babf789ee045c53c58fc44fbce171fa6 Mon Sep 17 00:00:00 2001 From: Dimitri BOUTEILLE Date: Fri, 31 Jan 2025 16:21:02 +0100 Subject: [PATCH 08/11] PHPDoc: Use \Stringable instead of \Magento\Framework\Message\ManagerInterface --- .../Framework/Message/ManagerInterface.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/ManagerInterface.php b/lib/internal/Magento/Framework/Message/ManagerInterface.php index dbcfa8a82fed2..bf4330892fafa 100644 --- a/lib/internal/Magento/Framework/Message/ManagerInterface.php +++ b/lib/internal/Magento/Framework/Message/ManagerInterface.php @@ -50,7 +50,7 @@ public function addMessages(array $messages, $group = null); /** * Adds new error message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -61,7 +61,7 @@ public function addError($message, $group = null); /** * Adds new warning message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -72,7 +72,7 @@ public function addWarning($message, $group = null); /** * Adds new notice message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -83,7 +83,7 @@ public function addNotice($message, $group = null); /** * Adds new success message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface * @deprecated 100.1.0 @@ -94,7 +94,7 @@ public function addSuccess($message, $group = null); /** * Adds new error message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface */ @@ -103,7 +103,7 @@ public function addErrorMessage($message, $group = null); /** * Adds new warning message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface */ @@ -112,7 +112,7 @@ public function addWarningMessage($message, $group = null); /** * Adds new notice message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface */ @@ -121,7 +121,7 @@ public function addNoticeMessage($message, $group = null); /** * Adds new success message * - * @param string|\Magento\Framework\Phrase $message + * @param string|\Stringable $message * @param string|null $group * @return ManagerInterface */ From d2c4cdbbed640428065b9daee3ddeed268781056 Mon Sep 17 00:00:00 2001 From: engcom-Charlie Date: Wed, 12 Feb 2025 15:07:07 +0530 Subject: [PATCH 09/11] Revert "Fixed static test failures" This reverts commit c8abbb92ac1b581d388ce1875e5e925b4249187f. --- .../Magento/Framework/Message/Manager.php | 20 ++++++------------- .../Framework/Message/ManagerInterface.php | 4 ++-- 2 files changed, 8 insertions(+), 16 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 1cf2d96d517e6..476ece21b540e 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -1,7 +1,7 @@ session = $session; $this->messageFactory = $messageFactory; @@ -94,9 +87,8 @@ public function __construct( $this->eventManager = $eventManager; $this->logger = $logger; $this->defaultGroup = $defaultGroup; - $this->exceptionMessageFactory = $exceptionMessageFactory ?: - ($this->exceptionMessageLookupFactory = $exceptionMessageLookupFactory ?: - ObjectManager::getInstance()->get(ExceptionMessageLookupFactory::class)); + $this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance() + ->get(ExceptionMessageLookupFactory::class); } /** diff --git a/lib/internal/Magento/Framework/Message/ManagerInterface.php b/lib/internal/Magento/Framework/Message/ManagerInterface.php index bf4330892fafa..7eefa46427f93 100644 --- a/lib/internal/Magento/Framework/Message/ManagerInterface.php +++ b/lib/internal/Magento/Framework/Message/ManagerInterface.php @@ -1,7 +1,7 @@ Date: Wed, 12 Feb 2025 15:16:43 +0530 Subject: [PATCH 10/11] After revert, fixed some code base to avoid static tests failures --- lib/internal/Magento/Framework/Message/Manager.php | 6 +++--- lib/internal/Magento/Framework/Message/ManagerInterface.php | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 476ece21b540e..5fd7fa4d907d6 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -1,7 +1,7 @@ Date: Thu, 13 Feb 2025 11:53:00 +0530 Subject: [PATCH 11/11] Fixed static test fialure --- lib/internal/Magento/Framework/Message/Manager.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php index 5fd7fa4d907d6..897bb268ad7b5 100644 --- a/lib/internal/Magento/Framework/Message/Manager.php +++ b/lib/internal/Magento/Framework/Message/Manager.php @@ -79,7 +79,7 @@ public function __construct( Event\ManagerInterface $eventManager, LoggerInterface $logger, $defaultGroup = self::DEFAULT_GROUP, - ExceptionMessageFactoryInterface $exceptionMessageFactory = null + ?ExceptionMessageFactoryInterface $exceptionMessageFactory = null ) { $this->session = $session; $this->messageFactory = $messageFactory; @@ -88,7 +88,7 @@ public function __construct( $this->logger = $logger; $this->defaultGroup = $defaultGroup; $this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance() - ->get(ExceptionMessageLookupFactory::class); + ->get(ExceptionMessageLookupFactory::class); // phpcs:ignore } /**