graphQl-44: refactoring of format strategy

Signed-off-by: vitaliyboyko <[email protected]>

Author: vitaliyboyko

app/code/Magento/CatalogGraphQl/Model/Resolver/Product/ProductTextAttribute.php

@@ -8,7 +8,7 @@
 namespace Magento\CatalogGraphQl\Model\Resolver\Product;
 
 use Magento\Catalog\Model\Product;
-use Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextareaAttribute\FormatFactory;
+use Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextAttribute\FormatList;
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Query\Resolver\Value;
 use Magento\Framework\GraphQl\Query\Resolver\ValueFactory;
@@ -18,30 +18,33 @@
 /**
  * Resolve rendered content for attributes where HTML content is allowed
  */
-class ProductTextareaAttribute implements ResolverInterface
+class ProductTextAttribute implements ResolverInterface
 {
-    const DEFAULT_CONTENT_FORMAT_IDENTIFIER = 'html';
+    /**
+     * @var FormatList
+     */
+    private $formatList;
 
     /**
      * @var ValueFactory
      */
     private $valueFactory;
 
     /**
-     * @var FormatFactory
+     * @var string
      */
-    private $formatFactory;
+    private $defaultFormat = 'html';
 
     /**
      * @param ValueFactory $valueFactory
-     * @param FormatFactory $formatFactory
+     * @param FormatList $formatFactory
      */
     public function __construct(
         ValueFactory $valueFactory,
-        FormatFactory $formatFactory
+        FormatList $formatFactory
     ) {
         $this->valueFactory = $valueFactory;
-        $this->formatFactory = $formatFactory;
+        $this->formatList = $formatFactory;
     }
 
     /**
@@ -55,22 +58,16 @@ public function resolve(
         array $args = null
     ): Value {
         if (!isset($value['model'])) {
-            $result = function () {
-                return null;
-            };
+            $result = [];
             return $this->valueFactory->create($result);
         }
 
         /* @var $product Product */
         $product = $value['model'];
         $fieldName = $field->getName();
-        $formatIdentifier = $args['format'] ?? self::DEFAULT_CONTENT_FORMAT_IDENTIFIER;
-        $format = $this->formatFactory->create($formatIdentifier);
-        $attribute = ['content' => $format->getContent($product, $fieldName)];
-
-        $result = function () use ($attribute) {
-            return $attribute;
-        };
+        $formatIdentifier = $args['format'] ?? $this->defaultFormat;
+        $format = $this->formatList->create($formatIdentifier);
+        $result = ['content' => $format->getContent($product, $fieldName)];
 
         return $this->valueFactory->create($result);
     }

app/code/Magento/CatalogGraphQl/Model/Resolver/Product/ProductTextAttribute/FormatInterface.php

@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextareaAttribute;
+namespace Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextAttribute;
 
 use Magento\Catalog\Model\Product as ModelProduct;
 

app/code/Magento/CatalogGraphQl/Model/Resolver/Product/ProductTextAttribute/FormatList.php

@@ -9,35 +9,39 @@
 
 use Magento\Framework\ObjectManagerInterface;
 
-class FormatFactory
+class FormatList
 {
     /**
      * @var ObjectManagerInterface
      */
     private $objectManager;
 
+    /**
+     * @var string
+     */
+    private $formats;
+
     /**
      * @param ObjectManagerInterface $objectManager
+     * @param array $formats
      */
-    public function __construct(ObjectManagerInterface $objectManager)
-    {
+    public function __construct(
+        ObjectManagerInterface $objectManager,
+        array $formats
+    ) {
         $this->objectManager = $objectManager;
+        $this->formats = $formats;
     }
 
     /**
      * @param string $formatIdentifier
-     * @param array $data
      * @return FormatInterface
      */
-    public function create(string $formatIdentifier, $data = []) : FormatInterface
+    public function create(string $formatIdentifier) : FormatInterface
     {
-        $formatClassName = 'Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextareaAttribute\\' . ucfirst($formatIdentifier);
-        $formatInstance = $this->objectManager->create($formatClassName, $data);
-        if (false == $formatInstance instanceof FormatInterface) {
-            throw new \InvalidArgumentException(
-                $formatInstance . ' is not instance of \Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextareaAttribute\FormatInterface'
-            );
-        }
+        $formatClassName = 'Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextAttribute\\' . ucfirst($formatIdentifier);
+        $formatInstance = $this->objectManager->get($formatClassName);
+
         return $formatInstance;
     }
 }

app/code/Magento/CatalogGraphQl/Model/Resolver/Product/ProductTextAttribute/Html.php

@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextareaAttribute;
+namespace Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextAttribute;
 
 use Magento\Framework\GraphQl\Query\Resolver\ValueFactory;
 use Magento\Catalog\Helper\Output as OutputHelper;

app/code/Magento/CatalogGraphQl/etc/graphql/di.xml

@@ -63,6 +63,13 @@
             <argument name="collectionProcessor" xsi:type="object">Magento\Catalog\Model\Api\SearchCriteria\ProductCollectionProcessor</argument>
         </arguments>
     </type>
+    <type name="Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextAttribute\FormatList">
+        <arguments>
+            <argument name="formats" xsi:type="array">
+                <item name="html" xsi:type="string">Magento\CatalogGraphQl\Model\Resolver\Product\ProductTextAttribute\Html</item>
+            </argument>
+        </arguments>
+    </type>
     <virtualType name="Magento\Catalog\Model\Api\SearchCriteria\CollectionProcessor\ProductFilterProcessor" type="Magento\Eav\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor">
         <arguments>
             <argument name="customFilters" xsi:type="array">

app/code/Magento/CatalogGraphQl/etc/schema.graphqls

@@ -248,8 +248,8 @@ interface ProductInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\
     id: Int @doc(description: "The ID number assigned to the product") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\EntityIdToId")
     name: String @doc(description: "The product name. Customers use this name to identify the product.")
     sku: String @doc(description: "A number or code assigned to a product to identify the product, options, price, and manufacturer")
-    description: ProductTextareaAttribute @doc(description: "Detailed information about the product. The value can include simple HTML tags.")
-    short_description: ProductTextareaAttribute @doc(description: "A short description of the product. Its use depends on the theme.")
+    description: ProductTextAttribute @doc(description: "Detailed information about the product. The value can include simple HTML tags.")
+    short_description: ProductTextAttribute @doc(description: "A short description of the product. Its use depends on the theme.")
     special_price: Float @doc(description: "The discounted price of the product")
     special_from_date: String @doc(description: "The beginning date that a product has a special price")
     special_to_date: String @doc(description: "The end date that a product has a special price")
@@ -552,9 +552,9 @@ type SortFields @doc(description: "SortFields contains a default value for sort
     options: [SortField] @doc(description: "Available sort fields")
 }
 
-type ProductTextareaAttribute {
+type ProductTextAttribute {
     content (
-    format: String! @doc(description: "The format of content")
-): String
-    @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductTextareaAttribute")
+    format: String @doc(description: "The format of content")
+): String @doc(description: "The format of content")
+    @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductTextAttribute")
 }