MAGETWO-60442: Add optional SerializerInterface dependency to child classes of \Magento\Framework\Config\Data

Igor Melnikov · Igor Melnikov · commit 47df808ef213 · 2016-11-04T16:15:13.000-05:00
Adding class and __constructor descriptions
diff --git a/app/code/Magento/Catalog/Model/Attribute/Config/Data.php b/app/code/Magento/Catalog/Model/Attribute/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides catalog attributes configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param \Magento\Catalog\Model\Attribute\Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Catalog/Model/ProductOptions/Config.php b/app/code/Magento/Catalog/Model/ProductOptions/Config.php
@@ -7,10 +7,15 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides product options configuration
+ */
 class Config extends \Magento\Framework\Config\Data implements
     \Magento\Catalog\Model\ProductOptions\ConfigInterface
 {
     /**
+     * Constructor
+     *
      * @param \Magento\Catalog\Model\ProductOptions\Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Catalog/Model/ProductTypes/Config.php b/app/code/Magento/Catalog/Model/ProductTypes/Config.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides product types configuration
+ */
 class Config extends \Magento\Framework\Config\Data implements \Magento\Catalog\Model\ProductTypes\ConfigInterface
 {
     /**
+     * Constructor
+     *
      * @param Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Config/Model/Config/Structure/Data.php b/app/code/Magento/Config/Model/Config/Structure/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides configuration
+ */
 class Data extends \Magento\Framework\Config\Data\Scoped
 {
     /**
+     * Constructor
+     *
      * @param Reader $reader
      * @param \Magento\Framework\Config\ScopeInterface $configScope
      * @param \Magento\Framework\Config\CacheInterface $cache
diff --git a/app/code/Magento/Cron/Model/Config/Data.php b/app/code/Magento/Cron/Model/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides cron configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param Reader\Xml $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param Reader\Db $dbReader
diff --git a/app/code/Magento/Cron/Model/Groups/Config/Data.php b/app/code/Magento/Cron/Model/Groups/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides cron groups configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param \Magento\Cron\Model\Groups\Config\Reader\Xml $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Customer/Model/Address/Config.php b/app/code/Magento/Customer/Model/Address/Config.php
@@ -11,7 +11,7 @@
 use Magento\Store\Model\ScopeInterface;
 
 /**
- * Customer address config
+ * Customer address configuration
  */
 class Config extends ConfigData
 {
@@ -36,8 +36,7 @@ class Config extends ConfigData
     protected $_store = null;
 
     /**
-     * Default types per store
-     * Using for invalid code
+     * Default types per store, used for invalid code
      *
      * @var array
      */
@@ -59,6 +58,8 @@ class Config extends ConfigData
     protected $_scopeConfig;
 
     /**
+     * Constructor
+     *
      * @param Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
diff --git a/app/code/Magento/Directory/Model/Country/Postcode/Config/Data.php b/app/code/Magento/Directory/Model/Country/Postcode/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides country postcodes configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/Config.php b/app/code/Magento/Eav/Model/Entity/Attribute/Config.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides EAV attributes configuration
+ */
 class Config extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Email/Model/Template/Config/Data.php b/app/code/Magento/Email/Model/Template/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides email templates configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param \Magento\Email\Model\Template\Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/ImportExport/Model/Export/Config.php b/app/code/Magento/ImportExport/Model/Export/Config.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides export configuration
+ */
 class Config extends \Magento\Framework\Config\Data implements \Magento\ImportExport\Model\Export\ConfigInterface
 {
     /**
+     * Constructor
+     *
      * @param Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/ImportExport/Model/Import/Config.php b/app/code/Magento/ImportExport/Model/Import/Config.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides import configuration
+ */
 class Config extends \Magento\Framework\Config\Data implements \Magento\ImportExport\Model\Import\ConfigInterface
 {
     /**
+     * Constructor
+     *
      * @param Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Indexer/Model/Config/Data.php b/app/code/Magento/Indexer/Model/Config/Data.php
@@ -6,9 +6,11 @@
 namespace Magento\Indexer\Model\Config;
 
 use Magento\Framework\Serialize\SerializerInterface;
-use Magento\Framework\Serialize\Serializer\Serialize;
 use Magento\Framework\App\ObjectManager;
 
+/**
+ * Provides indexer configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
@@ -17,6 +19,8 @@ class Data extends \Magento\Framework\Config\Data
     protected $stateCollection;
 
     /**
+     * Constructor
+     *
      * @param \Magento\Framework\Indexer\Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param \Magento\Indexer\Model\ResourceModel\Indexer\State\Collection $stateCollection
@@ -31,7 +35,6 @@ public function __construct(
         SerializerInterface $serializer = null
     ) {
         $this->stateCollection = $stateCollection;
-        $serializer = $serializer ?: ObjectManager::getInstance()->get(Serialize::class);
 
         $isCacheExists = $cache->test($cacheId);
 
diff --git a/app/code/Magento/Sales/Model/Config/Data.php b/app/code/Magento/Sales/Model/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides sales configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/app/code/Magento/Search/Model/SearchEngine/Config/Data.php b/app/code/Magento/Search/Model/SearchEngine/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides search engine configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param \Magento\Framework\Search\SearchEngine\Config\Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/lib/internal/Magento/Framework/Api/ExtensionAttribute/Config.php b/lib/internal/Magento/Framework/Api/ExtensionAttribute/Config.php
@@ -20,6 +20,8 @@ class Config extends \Magento\Framework\Config\Data
     const CACHE_ID = 'extension_attributes_config';
 
     /**
+     * Constructor
+     *
      * @param Reader $reader
      * @param CacheInterface $cache
      * @param string $cacheId|null
diff --git a/lib/internal/Magento/Framework/Cache/Config/Data.php b/lib/internal/Magento/Framework/Cache/Config/Data.php
@@ -20,6 +20,8 @@ class Data extends \Magento\Framework\Config\Data\Scoped
     protected $_scopePriorityScheme = ['global'];
 
     /**
+     * Constructor
+     *
      * @param \Magento\Framework\Cache\Config\Reader $reader
      * @param \Magento\Framework\Config\ScopeInterface $configScope
      * @param \Magento\Framework\Config\CacheInterface $cache
diff --git a/lib/internal/Magento/Framework/Communication/Config/Data.php b/lib/internal/Magento/Framework/Communication/Config/Data.php
@@ -7,9 +7,14 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides communication configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
+     * Constructor
+     *
      * @param \Magento\Framework\Communication\Config\CompositeReader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param string|null $cacheId
diff --git a/lib/internal/Magento/Framework/Config/Data.php b/lib/internal/Magento/Framework/Config/Data.php
@@ -16,14 +16,14 @@
 class Data implements \Magento\Framework\Config\DataInterface
 {
     /**
-     * Configuration reader model
+     * Configuration reader
      *
      * @var ReaderInterface
      */
     protected $_reader;
 
     /**
-     * Configuration cache model
+     * Configuration cache
      *
      * @var CacheInterface
      */
@@ -71,6 +71,8 @@ class Data implements \Magento\Framework\Config\DataInterface
     protected $serializer;
 
     /**
+     * Constructor
+     *
      * @param ReaderInterface $reader
      * @param CacheInterface $cache
      * @param string $cacheId
diff --git a/lib/internal/Magento/Framework/Config/Data/Scoped.php b/lib/internal/Magento/Framework/Config/Data/Scoped.php
@@ -8,6 +8,9 @@
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\App\ObjectManager;
 
+/**
+ * Provides scoped configuration
+ */
 class Scoped extends \Magento\Framework\Config\Data
 {
     /**
@@ -53,6 +56,8 @@ class Scoped extends \Magento\Framework\Config\Data
     protected $_loadedScopes = [];
 
     /**
+     * Constructor
+     *
      * @param \Magento\Framework\Config\ReaderInterface $reader
      * @param \Magento\Framework\Config\ScopeInterface $configScope
      * @param \Magento\Framework\Config\CacheInterface $cache
diff --git a/lib/internal/Magento/Framework/DataObject/Copy/Config/Data.php b/lib/internal/Magento/Framework/DataObject/Copy/Config/Data.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\DataObject\Copy\Config;
 
+/**
+ * Provides DataObject copier configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
 }
diff --git a/lib/internal/Magento/Framework/Event/Config/Data.php b/lib/internal/Magento/Framework/Event/Config/Data.php
@@ -7,6 +7,9 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides event configuration
+ */
 class Data extends \Magento\Framework\Config\Data\Scoped
 {
     /**
@@ -17,6 +20,8 @@ class Data extends \Magento\Framework\Config\Data\Scoped
     protected $_scopePriorityScheme = ['global'];
 
     /**
+     * Constructor
+     *
      * @param \Magento\Framework\Event\Config\Reader $reader
      * @param \Magento\Framework\Config\ScopeInterface $configScope
      * @param \Magento\Framework\Config\CacheInterface $cache
diff --git a/lib/internal/Magento/Framework/Interception/PluginList/PluginList.php b/lib/internal/Magento/Framework/Interception/PluginList/PluginList.php
@@ -83,6 +83,8 @@ class PluginList extends Scoped implements InterceptionPluginList
     private $logger;
 
     /**
+     * Constructor
+     *
      * @param ReaderInterface $reader
      * @param ScopeInterface $configScope
      * @param CacheInterface $cache
diff --git a/lib/internal/Magento/Framework/Mview/Config/Data.php b/lib/internal/Magento/Framework/Mview/Config/Data.php
@@ -7,6 +7,9 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Provides materialized view configuration
+ */
 class Data extends \Magento\Framework\Config\Data
 {
     /**
@@ -15,6 +18,8 @@ class Data extends \Magento\Framework\Config\Data
     protected $stateCollection;
 
     /**
+     * Constructor
+     *
      * @param Reader $reader
      * @param \Magento\Framework\Config\CacheInterface $cache
      * @param \Magento\Framework\Mview\View\State\CollectionInterface $stateCollection
diff --git a/lib/internal/Magento/Framework/ObjectManager/Config/Compiled.php b/lib/internal/Magento/Framework/ObjectManager/Config/Compiled.php
diff --git a/lib/internal/Magento/Framework/Search/Request/Config.php b/lib/internal/Magento/Framework/Search/Request/Config.php
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Generator/PluginList.php b/setup/src/Magento/Setup/Module/Di/Code/Generator/PluginList.php
