StoreSwitcher.php 1.8 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 54 55 56 57 58
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Store\Model;

use Magento\Store\Api\Data\StoreInterface;
use Magento\Store\Model\StoreSwitcher\CannotSwitchStoreException;

/**
 * Handles store switching procedure and detects url for final redirect after store switching.
 */
class StoreSwitcher implements StoreSwitcherInterface
{
    /**
     * @var StoreSwitcherInterface[]
     */
    private $storeSwitchers;

    /**
     * @param StoreSwitcherInterface[] $storeSwitchers
     * @throws \Exception
     */
    public function __construct(array $storeSwitchers)
    {
        foreach ($storeSwitchers as $switcherName => $switcherInstance) {
            if (!$switcherInstance instanceof StoreSwitcherInterface) {
                throw new \InvalidArgumentException(
                    "Store switcher '{$switcherName}' is expected to implement interface "
                    . StoreSwitcherInterface::class
                );
            }
        }
        $this->storeSwitchers = $storeSwitchers;
    }

    /**
     * @param StoreInterface $fromStore store where we came from
     * @param StoreInterface $targetStore store where to go to
     * @param string $redirectUrl original url requested for redirect after switching
     * @return string url to be redirected after switching
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     * @throws CannotSwitchStoreException
     */
    public function switch(StoreInterface $fromStore, StoreInterface $targetStore, string $redirectUrl): string
    {
        $targetUrl = $redirectUrl;

        foreach ($this->storeSwitchers as $storeSwitcher) {
            $targetUrl = $storeSwitcher->switch($fromStore, $targetStore, $targetUrl);
        }

        return $targetUrl;
    }
}