StoreDimensionProvider.php 1.34 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Store\Model;

use Magento\Framework\Indexer\DimensionFactory;
use Magento\Framework\Indexer\DimensionProviderInterface;

/**
 * Provide a list of stores as Dimension
 */
class StoreDimensionProvider implements DimensionProviderInterface
{
    /**
     * Hold the name of Store dimension. Uses for retrieve dimension value.
     * Used "scope" name for support current indexer implementation
     */
    const DIMENSION_NAME = 'scope';

    /**
     * @var StoreManagerInterface
     */
    private $storeManager;

    /**
     * @var DimensionFactory
     */
    private $dimensionFactory;

    /**
     * @param StoreManagerInterface $storeManager
     * @param DimensionFactory $dimensionFactory
     */
    public function __construct(StoreManagerInterface $storeManager, DimensionFactory $dimensionFactory)
    {
        $this->storeManager = $storeManager;
        $this->dimensionFactory = $dimensionFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): \Traversable
    {
        foreach (array_keys($this->storeManager->getStores()) as $storeId) {
            yield [self::DIMENSION_NAME => $this->dimensionFactory->create(self::DIMENSION_NAME, (string)$storeId)];
        }
    }
}