Replaced hardcoded custom option types and groups with injected array arguments (#24726)

Author: zhartaunik

app/code/Magento/Catalog/Model/Product/Option.php

@@ -11,6 +11,7 @@
 use Magento\Catalog\Api\Data\ProductCustomOptionValuesInterfaceFactory;
 use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Model\Product;
+use Magento\Catalog\Model\Product\Option\Type\DefaultType;
 use Magento\Catalog\Model\ResourceModel\Product\Option\Value\Collection;
 use Magento\Catalog\Pricing\Price\BasePrice;
 use Magento\Framework\EntityManager\MetadataPool;
@@ -98,6 +99,16 @@ class Option extends AbstractExtensibleModel implements ProductCustomOptionInter
      */
     protected $validatorPool;
 
+    /**
+     * @var DefaultType[]
+     */
+    private $groupsPool;
+
+    /**
+     * @var string[]
+     */
+    private $typesPool;
+
     /**
      * @var MetadataPool
      */
@@ -120,6 +131,8 @@ class Option extends AbstractExtensibleModel implements ProductCustomOptionInter
      * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
      * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
      * @param array $data
+     * @param array $groupsPool
+     * @param array $typesPool
      * @param ProductCustomOptionValuesInterfaceFactory|null $customOptionValuesFactory
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -135,12 +148,16 @@ public function __construct(
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = [],
+        array $groupsPool = [],
+        array $typesPool = [],
         ProductCustomOptionValuesInterfaceFactory $customOptionValuesFactory = null
     ) {
         $this->productOptionValue = $productOptionValue;
         $this->optionTypeFactory = $optionFactory;
-        $this->validatorPool = $validatorPool;
         $this->string = $string;
+        $this->validatorPool = $validatorPool;
+        $this->groupsPool = $groupsPool;
+        $this->typesPool = $typesPool;
         $this->customOptionValuesFactory = $customOptionValuesFactory ?:
             \Magento\Framework\App\ObjectManager::getInstance()->get(ProductCustomOptionValuesInterfaceFactory::class);
 
@@ -306,44 +323,30 @@ public function setProduct(Product $product = null)
     /**
      * Get group name of option by given option type
      *
-     * @param string $type
+     * @param string|null $type
      * @return string
      */
-    public function getGroupByType($type = null)
+    public function getGroupByType($type = null): string
     {
         if ($type === null) {
             $type = $this->getType();
         }
-        $optionGroupsToTypes = [
-            self::OPTION_TYPE_FIELD => self::OPTION_GROUP_TEXT,
-            self::OPTION_TYPE_AREA => self::OPTION_GROUP_TEXT,
-            self::OPTION_TYPE_FILE => self::OPTION_GROUP_FILE,
-            self::OPTION_TYPE_DROP_DOWN => self::OPTION_GROUP_SELECT,
-            self::OPTION_TYPE_RADIO => self::OPTION_GROUP_SELECT,
-            self::OPTION_TYPE_CHECKBOX => self::OPTION_GROUP_SELECT,
-            self::OPTION_TYPE_MULTIPLE => self::OPTION_GROUP_SELECT,
-            self::OPTION_TYPE_DATE => self::OPTION_GROUP_DATE,
-            self::OPTION_TYPE_DATE_TIME => self::OPTION_GROUP_DATE,
-            self::OPTION_TYPE_TIME => self::OPTION_GROUP_DATE,
-        ];
 
-        return $optionGroupsToTypes[$type] ?? '';
+        return $this->typesPool[$type] ?? '';
     }
 
     /**
      * Group model factory
      *
      * @param string $type Option type
-     * @return \Magento\Catalog\Model\Product\Option\Type\DefaultType
+     * @return DefaultType
      * @throws LocalizedException
      */
-    public function groupFactory($type)
+    public function groupFactory($type): DefaultType
     {
         $group = $this->getGroupByType($type);
-        if (!empty($group)) {
-            return $this->optionTypeFactory->create(
-                'Magento\Catalog\Model\Product\Option\Type\\' . $this->string->upperCaseWords($group)
-            );
+        if (!empty($group) && isset($this->groupsPool[$group])) {
+            return $this->optionTypeFactory->create($this->groupsPool[$group]);
         }
         throw new LocalizedException(__('The option type to get group instance is incorrect.'));
     }

app/code/Magento/Catalog/etc/di.xml

@@ -72,7 +72,6 @@
     <preference for="Magento\Catalog\Model\Indexer\Product\Price\UpdateIndexInterface" type="Magento\Catalog\Model\Indexer\Product\Price\InvalidateIndex" />
     <preference for="Magento\Catalog\Model\Product\Gallery\ImagesConfigFactoryInterface" type="Magento\Catalog\Model\Product\Gallery\ImagesConfigFactory" />
     <preference for="Magento\Catalog\Model\Product\Configuration\Item\ItemResolverInterface" type="Magento\Catalog\Model\Product\Configuration\Item\ItemResolverComposite" />
-    <preference for="Magento\Catalog\Api\Data\MassActionInterface" type="\Magento\Catalog\Model\MassAction" />
     <type name="Magento\Customer\Model\ResourceModel\Visitor">
         <plugin name="catalogLog" type="Magento\Catalog\Model\Plugin\Log" />
     </type>
@@ -411,6 +410,28 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Catalog\Model\Product\Option">
+        <arguments>
+            <argument name="groupsPool" xsi:type="array">
+                <item name="date" xsi:type="string">Magento\Catalog\Model\Product\Option\Type\Date</item>
+                <item name="file" xsi:type="string">Magento\Catalog\Model\Product\Option\Type\File</item>
+                <item name="select" xsi:type="string">Magento\Catalog\Model\Product\Option\Type\Select</item>
+                <item name="text" xsi:type="string">Magento\Catalog\Model\Product\Option\Type\Text</item>
+            </argument>
+            <argument name="typesPool" xsi:type="array">
+                <item name="field" xsi:type="string">text</item>
+                <item name="area" xsi:type="string">text</item>
+                <item name="file" xsi:type="string">file</item>
+                <item name="drop_down" xsi:type="string">select</item>
+                <item name="radio" xsi:type="string">select</item>
+                <item name="checkbox" xsi:type="string">select</item>
+                <item name="multiple" xsi:type="string">select</item>
+                <item name="date" xsi:type="string">date</item>
+                <item name="date_time" xsi:type="string">date</item>
+                <item name="time" xsi:type="string">date</item>
+            </argument>
+        </arguments>
+    </type>
     <type name="Magento\Catalog\Model\Product\Option\Validator\Pool">
         <arguments>
             <argument name="validators" xsi:type="array">