123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Theme\Model\ResourceModel\Design\Config\Scope;
- use Magento\Framework\App\Config\ScopeConfigInterface;
- use Magento\Framework\App\ScopeTreeProviderInterface;
- use Magento\Framework\Data\Collection\EntityFactoryInterface;
- use Magento\Theme\Model\Design\Config\MetadataProviderInterface;
- use Magento\Theme\Model\Design\Config\ValueProcessor;
- /**
- * Data collection
- *
- */
- class Collection extends \Magento\Framework\Data\Collection
- {
- /**
- * @var ScopeTreeProviderInterface
- */
- protected $scopeTree;
- /**
- * @var MetadataProviderInterface
- */
- protected $metadataProvider;
- /**
- * @var ScopeConfigInterface
- */
- protected $appConfig;
- /**
- * @var ValueProcessor
- */
- protected $valueProcessor;
- /**
- * Collection constructor
- *
- * @param EntityFactoryInterface $entityFactory
- * @param ScopeTreeProviderInterface $scopeTree
- * @param MetadataProviderInterface $metadataProvider
- * @param ScopeConfigInterface $appConfig
- * @param ValueProcessor $valueProcessor
- */
- public function __construct(
- EntityFactoryInterface $entityFactory,
- ScopeTreeProviderInterface $scopeTree,
- MetadataProviderInterface $metadataProvider,
- ScopeConfigInterface $appConfig,
- ValueProcessor $valueProcessor
- ) {
- parent::__construct($entityFactory);
- $this->scopeTree = $scopeTree;
- $this->metadataProvider = $metadataProvider;
- $this->appConfig = $appConfig;
- $this->valueProcessor = $valueProcessor;
- }
- /**
- * Load data
- *
- * @param bool $printQuery
- * @param bool $logQuery
- * @return \Magento\Theme\Model\ResourceModel\Design\Config\Scope\Collection
- *
- * @SuppressWarnings(PHPMD.UnusedFormalParameter)
- */
- public function loadData($printQuery = false, $logQuery = false)
- {
- if (!$this->isLoaded()) {
- $default = $this->scopeTree->get();
- $this->prepareItemData();
- foreach ($default['scopes'] as $website) {
- $this->prepareItemData($website);
- foreach ($website['scopes'] as $group) {
- foreach ($group['scopes'] as $store) {
- $this->prepareItemData($website, $group, $store);
- }
- }
- }
- $this->_setIsLoaded(true);
- }
- return $this;
- }
- /**
- * Retrieve fields metadata
- *
- * @param string $scope
- * @param int $scopeId
- * @return array
- */
- protected function getMetadataValues($scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeId = null)
- {
- $result = [];
- foreach ($this->metadataProvider->get() as $itemName => $itemData) {
- if (isset($itemData['use_in_grid']) && (boolean)$itemData['use_in_grid']) {
- $result[$itemName] = $this->valueProcessor->process(
- $this->appConfig->getValue($itemData['path'], $scope, $scopeId),
- $scope,
- $scopeId,
- $itemData
- );
- }
- }
- return $result;
- }
- /**
- * Prepare item data depend on scope
- *
- * @param array $websiteScope
- * @param array $groupScope
- * @param array $storeScope
- *
- * @return void
- */
- protected function prepareItemData(array $websiteScope = [], array $groupScope = [], array $storeScope = [])
- {
- $result = [
- 'store_website_id' => isset($websiteScope['scope_id']) ? $websiteScope['scope_id'] : null,
- 'store_group_id' => isset($groupScope['scope_id']) ? $groupScope['scope_id'] : null,
- 'store_id' => isset($storeScope['scope_id']) ? $storeScope['scope_id'] : null,
- ];
- $result = array_merge($result, $this->getScopeData($websiteScope, $groupScope, $storeScope));
- $this->_addItem(new \Magento\Framework\DataObject($result));
- }
- /**
- * Retrieve scope data
- *
- * @param array $websiteScope
- * @param array $groupScope
- * @param array $storeScope
- * @return array
- */
- protected function getScopeData(array $websiteScope, array $groupScope, array $storeScope)
- {
- if (isset($storeScope['scope'])) {
- $data = $this->getMetadataValues($storeScope['scope'], $storeScope['scope_id']);
- } elseif (isset($groupScope['scope'])) {
- $data = $this->getMetadataValues($groupScope['scope'], $groupScope['scope_id']);
- } elseif (isset($websiteScope['scope'])) {
- $data = $this->getMetadataValues($websiteScope['scope'], $websiteScope['scope_id']);
- } else {
- $data = $this->getMetadataValues();
- }
- return $data;
- }
- }
|