ACP2E-3152: Categories not working with widgets

- Initial Change with test

Author: arnobsh

app/code/Magento/Widget/Model/Widget/Instance.php

@@ -5,26 +5,42 @@
  */
 namespace Magento\Widget\Model\Widget;
 
+use Magento\Catalog\Model\Product\Type;
+use Magento\Framework\App\Cache\TypeListInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Config\Dom\ValidationException;
 use Magento\Framework\Config\Dom\ValidationSchemaException;
+use Magento\Framework\Data\Collection\AbstractDb;
+use Magento\Framework\Escaper;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Filesystem;
+use Magento\Framework\Filesystem\Directory\ReadInterface;
+use Magento\Framework\Math\Random;
+use Magento\Framework\Model\Context;
+use Magento\Framework\Model\ResourceModel\AbstractResource;
+use Magento\Framework\Phrase;
+use Magento\Framework\Registry;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\Simplexml\Element;
+use Magento\Framework\View\DesignInterface;
 use Magento\Framework\View\Model\Layout\Update\ValidatorFactory;
+use Magento\Widget\Helper\Conditions;
+use Magento\Widget\Model\Config\Reader;
+use Magento\Widget\Model\NamespaceResolver;
+use Magento\Widget\Model\Widget;
 
 /**
  * Widget Instance Model
  *
  * @api
  * @method string getTitle()
- * @method \Magento\Widget\Model\Widget\Instance setTitle(string $value)
- * @method \Magento\Widget\Model\Widget\Instance setStoreIds(string $value)
- * @method \Magento\Widget\Model\Widget\Instance setWidgetParameters(string|array $value)
+ * @method Instance setTitle(string $value)
+ * @method Instance setStoreIds(string $value)
+ * @method Instance setWidgetParameters(string|array $value)
  * @method int getSortOrder()
- * @method \Magento\Widget\Model\Widget\Instance setSortOrder(int $value)
- * @method \Magento\Widget\Model\Widget\Instance setThemeId(int $value)
+ * @method Instance setSortOrder(int $value)
+ * @method Instance setThemeId(int $value)
  * @method int getThemeId()
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@@ -84,17 +100,17 @@ class Instance extends \Magento\Framework\Model\AbstractModel
     protected $_viewFileSystem;
 
     /**
-     * @var \Magento\Widget\Model\Widget
+     * @var Widget
      */
     protected $_widgetModel;
 
     /**
-     * @var \Magento\Widget\Model\NamespaceResolver
+     * @var NamespaceResolver
      */
     protected $_namespaceResolver;
 
     /**
-     * @var \Magento\Framework\App\Cache\TypeListInterface
+     * @var TypeListInterface
      */
     protected $_cacheTypeList;
 
@@ -104,34 +120,34 @@ class Instance extends \Magento\Framework\Model\AbstractModel
     protected $_relatedCacheTypes;
 
     /**
-     * @var \Magento\Catalog\Model\Product\Type
+     * @var Type
      * @since 101.0.4
      */
     protected $_productType;
 
     /**
-     * @var \Magento\Widget\Model\Config\Reader
+     * @var Reader
      * @since 101.0.4
      */
     protected $_reader;
 
     /**
-     * @var \Magento\Framework\Escaper
+     * @var Escaper
      */
     protected $_escaper;
 
     /**
-     * @var \Magento\Framework\Math\Random
+     * @var Random
      */
     protected $mathRandom;
 
     /**
-     * @var \Magento\Framework\Filesystem\Directory\ReadInterface
+     * @var ReadInterface
      */
     protected $_directory;
 
     /**
-     * @var \Magento\Widget\Helper\Conditions
+     * @var Conditions
      */
     protected $conditionsHelper;
 
@@ -146,41 +162,42 @@ class Instance extends \Magento\Framework\Model\AbstractModel
     private $xmlValidatorFactory;
 
     /**
-     * @param \Magento\Framework\Model\Context $context
-     * @param \Magento\Framework\Registry $registry
-     * @param \Magento\Framework\Escaper $escaper
+     * @param Context $context
+     * @param Registry $registry
+     * @param Escaper $escaper
      * @param \Magento\Framework\View\FileSystem $viewFileSystem
-     * @param \Magento\Framework\App\Cache\TypeListInterface $cacheTypeList
-     * @param \Magento\Catalog\Model\Product\Type $productType
-     * @param \Magento\Widget\Model\Config\Reader $reader
-     * @param \Magento\Widget\Model\Widget $widgetModel
-     * @param \Magento\Widget\Model\NamespaceResolver $namespaceResolver
-     * @param \Magento\Framework\Math\Random $mathRandom
-     * @param \Magento\Framework\Filesystem $filesystem
-     * @param \Magento\Widget\Helper\Conditions $conditionsHelper
-     * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
-     * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
+     * @param TypeListInterface $cacheTypeList
+     * @param Type $productType
+     * @param Reader $reader
+     * @param Widget $widgetModel
+     * @param NamespaceResolver $namespaceResolver
+     * @param Random $mathRandom
+     * @param Filesystem $filesystem
+     * @param Conditions $conditionsHelper
+     * @param AbstractResource|null $resource
+     * @param AbstractDb|null $resourceCollection
      * @param array $relatedCacheTypes
      * @param array $data
-     * @param \Magento\Framework\Serialize\Serializer\Json $serializer
+     * @param Json|null $serializer
      * @param ValidatorFactory|null $xmlValidatorFactory
+     * @throws LocalizedException
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
-        \Magento\Framework\Model\Context $context,
-        \Magento\Framework\Registry $registry,
-        \Magento\Framework\Escaper $escaper,
+        Context $context,
+        Registry $registry,
+        Escaper $escaper,
         \Magento\Framework\View\FileSystem $viewFileSystem,
-        \Magento\Framework\App\Cache\TypeListInterface $cacheTypeList,
-        \Magento\Catalog\Model\Product\Type $productType,
-        \Magento\Widget\Model\Config\Reader $reader,
-        \Magento\Widget\Model\Widget $widgetModel,
-        \Magento\Widget\Model\NamespaceResolver $namespaceResolver,
-        \Magento\Framework\Math\Random $mathRandom,
-        \Magento\Framework\Filesystem $filesystem,
-        \Magento\Widget\Helper\Conditions $conditionsHelper,
-        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
-        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
+        TypeListInterface $cacheTypeList,
+        Type $productType,
+        Reader $reader,
+        Widget $widgetModel,
+        NamespaceResolver $namespaceResolver,
+        Random $mathRandom,
+        Filesystem $filesystem,
+        Conditions $conditionsHelper,
+        AbstractResource $resource = null,
+        AbstractDb $resourceCollection = null,
         array $relatedCacheTypes = [],
         array $data = [],
         Json $serializer = null,
@@ -206,6 +223,7 @@ public function __construct(
      * Internal Constructor
      *
      * @return void
+     * @throws LocalizedException
      */
     protected function _construct()
     {
@@ -235,6 +253,7 @@ protected function _construct()
      * @return $this
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @throws LocalizedException
      */
     public function beforeSave()
     {
@@ -271,7 +290,7 @@ public function beforeSave()
                         foreach (explode(',', $pageGroupData['entities'] ?? '') as $entity) {
                             $layoutHandleUpdates[] = str_replace(
                                 '{{ID}}',
-                                $entity,
+                                trim($entity),
                                 $this->_specificEntitiesLayoutHandles[$pageGroup['page_group']]
                             );
                         }
@@ -290,7 +309,7 @@ public function beforeSave()
             if (array_key_exists('show_pager', $parameters) && !array_key_exists('page_var_name', $parameters)) {
                 $parameters['page_var_name'] = 'p' . $this->mathRandom->getRandomString(
                     5,
-                    \Magento\Framework\Math\Random::CHARS_LOWERS
+                    Random::CHARS_LOWERS
                 );
             }
 
@@ -305,7 +324,7 @@ public function beforeSave()
     /**
      * Validate widget instance data
      *
-     * @return \Magento\Framework\Phrase|bool
+     * @return Phrase|bool
      */
     public function validate()
     {
@@ -391,7 +410,7 @@ public function getArea()
     {
         //TODO Shouldn't we get "area" from theme model which we can load using "theme_id"?
         if (!$this->_getData('area')) {
-            return \Magento\Framework\View\DesignInterface::DEFAULT_AREA;
+            return DesignInterface::DEFAULT_AREA;
         }
         return $this->_getData('area');
     }
@@ -628,6 +647,7 @@ private function getWidgetTemplatesFromConfig(
      * @return string
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @throws LocalizedException
      */
     public function generateLayoutUpdateXml($container, $templatePath = '')
     {
@@ -750,6 +770,7 @@ public function afterSave()
      * Invalidate related cache if instance contain layout updates
      *
      * @return $this
+     * @throws LocalizedException
      */
     public function beforeDelete()
     {