From 47df808ef213e47d29c4ad1d9f3d0014fc797301 Mon Sep 17 00:00:00 2001 From: Igor Melnikov <imelnikov@magento.com> Date: Fri, 4 Nov 2016 16:15:13 -0500 Subject: [PATCH] MAGETWO-60442: Add optional SerializerInterface dependency to child classes of \Magento\Framework\Config\Data Adding class and __constructor descriptions --- app/code/Magento/Catalog/Model/Attribute/Config/Data.php | 5 +++++ app/code/Magento/Catalog/Model/ProductOptions/Config.php | 5 +++++ app/code/Magento/Catalog/Model/ProductTypes/Config.php | 5 +++++ app/code/Magento/Config/Model/Config/Structure/Data.php | 5 +++++ app/code/Magento/Cron/Model/Config/Data.php | 5 +++++ app/code/Magento/Cron/Model/Groups/Config/Data.php | 5 +++++ app/code/Magento/Customer/Model/Address/Config.php | 7 ++++--- .../Directory/Model/Country/Postcode/Config/Data.php | 5 +++++ app/code/Magento/Eav/Model/Entity/Attribute/Config.php | 5 +++++ app/code/Magento/Email/Model/Template/Config/Data.php | 5 +++++ app/code/Magento/ImportExport/Model/Export/Config.php | 5 +++++ app/code/Magento/ImportExport/Model/Import/Config.php | 5 +++++ app/code/Magento/Indexer/Model/Config/Data.php | 7 +++++-- app/code/Magento/Sales/Model/Config/Data.php | 5 +++++ app/code/Magento/Search/Model/SearchEngine/Config/Data.php | 5 +++++ .../Magento/Framework/Api/ExtensionAttribute/Config.php | 2 ++ lib/internal/Magento/Framework/Cache/Config/Data.php | 2 ++ .../Magento/Framework/Communication/Config/Data.php | 5 +++++ lib/internal/Magento/Framework/Config/Data.php | 6 ++++-- lib/internal/Magento/Framework/Config/Data/Scoped.php | 5 +++++ .../Magento/Framework/DataObject/Copy/Config/Data.php | 3 +++ lib/internal/Magento/Framework/Event/Config/Data.php | 5 +++++ .../Framework/Interception/PluginList/PluginList.php | 2 ++ lib/internal/Magento/Framework/Mview/Config/Data.php | 5 +++++ .../Magento/Framework/ObjectManager/Config/Compiled.php | 5 +++++ lib/internal/Magento/Framework/Search/Request/Config.php | 5 +++++ .../Magento/Setup/Module/Di/Code/Generator/PluginList.php | 3 +++ 27 files changed, 120 insertions(+), 7 deletions(-) diff --git a/app/code/Magento/Catalog/Model/Attribute/Config/Data.php b/app/code/Magento/Catalog/Model/Attribute/Config/Data.php index 08128376439..1fac4e58c75 100644 --- a/app/code/Magento/Catalog/Model/Attribute/Config/Data.php +++ b/app/code/Magento/Catalog/Model/Attribute/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Catalog\Model\Attribute\Config; 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 index f78eb0e4f50..fa828832bf4 100644 --- a/app/code/Magento/Catalog/Model/ProductOptions/Config.php +++ b/app/code/Magento/Catalog/Model/ProductOptions/Config.php @@ -7,10 +7,15 @@ namespace Magento\Catalog\Model\ProductOptions; 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 index 7a5465e525b..f691e08a34b 100644 --- a/app/code/Magento/Catalog/Model/ProductTypes/Config.php +++ b/app/code/Magento/Catalog/Model/ProductTypes/Config.php @@ -7,9 +7,14 @@ namespace Magento\Catalog\Model\ProductTypes; 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 index d785ce2b908..6c926e7c1da 100644 --- a/app/code/Magento/Config/Model/Config/Structure/Data.php +++ b/app/code/Magento/Config/Model/Config/Structure/Data.php @@ -7,9 +7,14 @@ namespace Magento\Config\Model\Config\Structure; 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 index 0e685aa9102..bcfaef37ece 100644 --- a/app/code/Magento/Cron/Model/Config/Data.php +++ b/app/code/Magento/Cron/Model/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Cron\Model\Config; 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 index 5c69cf9667b..82c35abff22 100644 --- a/app/code/Magento/Cron/Model/Groups/Config/Data.php +++ b/app/code/Magento/Cron/Model/Groups/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Cron\Model\Groups\Config; 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 index 7170cf3d238..18a043bc019 100644 --- a/app/code/Magento/Customer/Model/Address/Config.php +++ b/app/code/Magento/Customer/Model/Address/Config.php @@ -11,7 +11,7 @@ use Magento\Framework\Serialize\SerializerInterface; 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 index 1a5241e0a11..c24da536e77 100644 --- 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 @@ namespace Magento\Directory\Model\Country\Postcode\Config; 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 index d7c5edd8485..1bc5bba6d5e 100644 --- a/app/code/Magento/Eav/Model/Entity/Attribute/Config.php +++ b/app/code/Magento/Eav/Model/Entity/Attribute/Config.php @@ -7,9 +7,14 @@ namespace Magento\Eav\Model\Entity\Attribute; 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 index e1d00e20e8d..1f6a4beb166 100644 --- a/app/code/Magento/Email/Model/Template/Config/Data.php +++ b/app/code/Magento/Email/Model/Template/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Email\Model\Template\Config; 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 index a2e1a02ffd3..2d7b2c7a3af 100644 --- a/app/code/Magento/ImportExport/Model/Export/Config.php +++ b/app/code/Magento/ImportExport/Model/Export/Config.php @@ -7,9 +7,14 @@ namespace Magento\ImportExport\Model\Export; 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 index 82630378521..a1ec492da3e 100644 --- a/app/code/Magento/ImportExport/Model/Import/Config.php +++ b/app/code/Magento/ImportExport/Model/Import/Config.php @@ -7,9 +7,14 @@ namespace Magento\ImportExport\Model\Import; 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 index cf6ea584196..3cedaa51ef4 100644 --- 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 @@ class Data extends \Magento\Framework\Config\Data 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 index bbd90a302f6..b6a1b43012f 100644 --- a/app/code/Magento/Sales/Model/Config/Data.php +++ b/app/code/Magento/Sales/Model/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Sales\Model\Config; 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 index 213a92958ac..d128a9d5002 100644 --- a/app/code/Magento/Search/Model/SearchEngine/Config/Data.php +++ b/app/code/Magento/Search/Model/SearchEngine/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Search\Model\SearchEngine\Config; 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 index 32d2b75ed5e..1dcfe02e56b 100644 --- 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 index 3a2ba6c8c0d..5909fff105e 100644 --- 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 index ea2965b1a44..29667100b68 100644 --- a/lib/internal/Magento/Framework/Communication/Config/Data.php +++ b/lib/internal/Magento/Framework/Communication/Config/Data.php @@ -7,9 +7,14 @@ namespace Magento\Framework\Communication\Config; 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 index 0723e40dbfe..57b6769d3e5 100644 --- a/lib/internal/Magento/Framework/Config/Data.php +++ b/lib/internal/Magento/Framework/Config/Data.php @@ -16,14 +16,14 @@ use Magento\Framework\App\ObjectManager; 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 index 55a354f0d2a..02379834c5e 100644 --- a/lib/internal/Magento/Framework/Config/Data/Scoped.php +++ b/lib/internal/Magento/Framework/Config/Data/Scoped.php @@ -8,6 +8,9 @@ namespace Magento\Framework\Config\Data; 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 index 731eb9d685d..5f2a1518d48 100644 --- 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 index d5858be832f..4b69e597934 100644 --- a/lib/internal/Magento/Framework/Event/Config/Data.php +++ b/lib/internal/Magento/Framework/Event/Config/Data.php @@ -7,6 +7,9 @@ namespace Magento\Framework\Event\Config; 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 index f74213eaf4a..dc3ddea2c6f 100644 --- 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 index 0ddf85d5d5c..fed3021a161 100644 --- a/lib/internal/Magento/Framework/Mview/Config/Data.php +++ b/lib/internal/Magento/Framework/Mview/Config/Data.php @@ -7,6 +7,9 @@ namespace Magento\Framework\Mview\Config; 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 index 0db65f3b6b5..0260af34ef1 100644 --- a/lib/internal/Magento/Framework/ObjectManager/Config/Compiled.php +++ b/lib/internal/Magento/Framework/ObjectManager/Config/Compiled.php @@ -11,6 +11,9 @@ use Magento\Framework\Serialize\Serializer\Serialize; use Magento\Framework\ObjectManager\ConfigCacheInterface; use Magento\Framework\ObjectManager\RelationsInterface; +/** + * Provides object manager configuration when in compiled mode + */ class Compiled implements ConfigInterface { /** @@ -34,6 +37,8 @@ class Compiled implements ConfigInterface private $serializer; /** + * Constructor + * * @param array $data */ public function __construct($data) diff --git a/lib/internal/Magento/Framework/Search/Request/Config.php b/lib/internal/Magento/Framework/Search/Request/Config.php index 4793c4b51c4..80a963af39b 100644 --- a/lib/internal/Magento/Framework/Search/Request/Config.php +++ b/lib/internal/Magento/Framework/Search/Request/Config.php @@ -7,6 +7,9 @@ namespace Magento\Framework\Search\Request; use Magento\Framework\Serialize\SerializerInterface; +/** + * Provides search request configuration + */ class Config extends \Magento\Framework\Config\Data { /** @@ -15,6 +18,8 @@ class Config extends \Magento\Framework\Config\Data const CACHE_ID = 'request_declaration'; /** + * Constructor + * * @param \Magento\Framework\Search\Request\Config\FilesystemReader $reader * @param \Magento\Framework\Config\CacheInterface $cache * @param string|null $cacheId diff --git a/setup/src/Magento/Setup/Module/Di/Code/Generator/PluginList.php b/setup/src/Magento/Setup/Module/Di/Code/Generator/PluginList.php index 5853ae8a51c..851bfa8c363 100644 --- a/setup/src/Magento/Setup/Module/Di/Code/Generator/PluginList.php +++ b/setup/src/Magento/Setup/Module/Di/Code/Generator/PluginList.php @@ -7,6 +7,9 @@ namespace Magento\Setup\Module\Di\Code\Generator; use Magento\Framework\Interception; +/** + * Provides plugin list configuration + */ class PluginList extends Interception\PluginList\PluginList { /** -- GitLab