ENGCOM-5593: Replace annoying multi-line warning with short message + context #23894

Author: sidolov

app/code/Magento/Eav/Model/ResourceModel/ReadHandler.php

@@ -3,20 +3,27 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Eav\Model\ResourceModel;
 
+use Exception;
 use Magento\Eav\Model\Config;
+use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
 use Magento\Framework\DataObject;
 use Magento\Framework\DB\Select;
 use Magento\Framework\DB\Sql\UnionExpression;
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\EntityManager\Operation\AttributeInterface;
+use Magento\Framework\Exception\ConfigurationMismatchException;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Model\Entity\ScopeInterface;
 use Magento\Framework\Model\Entity\ScopeResolver;
 use Psr\Log\LoggerInterface;
 
 /**
  * EAV read handler
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ReadHandler implements AttributeInterface
 {
@@ -63,7 +70,7 @@ public function __construct(
      *
      * @param string $entityType
      * @return \Magento\Eav\Api\Data\AttributeInterface[]
-     * @throws \Exception if for unknown entity type
+     * @throws Exception if for unknown entity type
      * @deprecated Not used anymore
      * @see ReadHandler::getEntityAttributes
      */
@@ -80,7 +87,7 @@ protected function getAttributes($entityType)
      * @param string $entityType
      * @param DataObject $entity
      * @return \Magento\Eav\Api\Data\AttributeInterface[]
-     * @throws \Exception if for unknown entity type
+     * @throws Exception if for unknown entity type
      */
     private function getEntityAttributes(string $entityType, DataObject $entity): array
     {
@@ -111,9 +118,9 @@ protected function getContextVariables(ScopeInterface $scope)
      * @param array $entityData
      * @param array $arguments
      * @return array
-     * @throws \Exception
-     * @throws \Magento\Framework\Exception\ConfigurationMismatchException
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws Exception
+     * @throws ConfigurationMismatchException
+     * @throws LocalizedException
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function execute($entityType, $entityData, $arguments = [])
@@ -129,7 +136,7 @@ public function execute($entityType, $entityData, $arguments = [])
         $attributesMap = [];
         $selects = [];
 
-        /** @var \Magento\Eav\Model\Entity\Attribute\AbstractAttribute $attribute */
+        /** @var AbstractAttribute $attribute */
         foreach ($this->getEntityAttributes($entityType, new DataObject($entityData)) as $attribute) {
             if (!$attribute->isStatic()) {
                 $attributeTables[$attribute->getBackend()->getTable()][] = $attribute->getAttributeId();
@@ -170,8 +177,11 @@ public function execute($entityType, $entityData, $arguments = [])
                     $entityData[$attributesMap[$attributeValue['attribute_id']]] = $attributeValue['value'];
                 } else {
                     $this->logger->warning(
-                        "Attempt to load value of nonexistent EAV attribute '{$attributeValue['attribute_id']}'
-                        for entity type '$entityType'."
+                        "Attempt to load value of nonexistent EAV attribute",
+                        [
+                            'attribute_id' => $attributeValue['attribute_id'],
+                            'entity_type' => $entityType
+                        ]
                     );
                 }
             }
@@ -184,8 +194,9 @@ public function execute($entityType, $entityData, $arguments = [])
      *
      * @param Select[] $selects
      * @param array $identifiers
+     * @return void
      */
-    private function applyIdentifierForSelects(array $selects, array $identifiers)
+    private function applyIdentifierForSelects(array $selects, array $identifiers): void
     {
         foreach ($selects as $select) {
             foreach ($identifiers as $identifier) {