StoreRepository Class Reference

Inheritance diagram for StoreRepository:

Public Member Functions
	__construct (StoreFactory $storeFactory, \Magento\Store\Model\ResourceModel\Store\CollectionFactory $storeCollectionFactory)
	get ($code)
	getActiveStoreByCode ($code)
	getById ($id)
	getActiveStoreById ($id)
	getList ()
	clean ()

Protected Attributes
	$storeFactory
	$storeCollectionFactory
	$entities = []
	$entitiesById = []
	$allLoaded = false

Detailed Description

Information Expert in stores handling

Definition at line 16 of file StoreRepository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	StoreFactory	$storeFactory,
		\Magento\Store\Model\ResourceModel\Store\CollectionFactory	$storeCollectionFactory
	)

Parameters

StoreFactory	$storeFactory
\Magento\Store\Model\ResourceModel\Store\CollectionFactory	$storeCollectionFactory

Definition at line 52 of file StoreRepository.php.

      {
        $this->storeFactory = $storeFactory;
        $this->storeCollectionFactory = $storeCollectionFactory;
    }

Member Function Documentation

clean()

clean

(

)

{Clear cached entities

Returns

void

}

Implements StoreRepositoryInterface.

Definition at line 172 of file StoreRepository.php.

    {
        $this->entities = [];
        $this->entitiesById = [];
        $this->allLoaded = false;
    }

get()

get

(

$code

)

{Retrieve store by code

Parameters

string

$code

Returns

\Magento\Store\Api\Data\StoreInterface

Exceptions

NoSuchEntityException

}

Implements StoreRepositoryInterface.

Definition at line 63 of file StoreRepository.php.

    {
        if (isset($this->entities[$code])) {
            return $this->entities[$code];
        }

        $storeData = $this->getAppConfig()->get('scopes', "stores/$code", []);
        $store = $this->storeFactory->create([
            'data' => $storeData
        ]);

        if ($store->getId() === null) {
            throw new NoSuchEntityException(
                __("The store that was requested wasn't found. Verify the store and try again.")
            );
        }
        $this->entities[$code] = $store;
        $this->entitiesById[$store->getId()] = $store;
        return $store;
    }

getActiveStoreByCode()

getActiveStoreByCode

(

$code

)

{Retrieve active store by code

Parameters

string

$code

Returns

\Magento\Store\Api\Data\StoreInterface

Exceptions

NoSuchEntityException
StoreIsInactiveException

}

Implements StoreRepositoryInterface.

Definition at line 87 of file StoreRepository.php.

    {
        $store = $this->get($code);

        if (!$store->isActive()) {
            throw new StoreIsInactiveException();
        }
        return $store;
    }

getActiveStoreById()

getActiveStoreById

(

$id

)

{Retrieve active store by id

Parameters

int

$id

Returns

\Magento\Store\Api\Data\StoreInterface

Exceptions

NoSuchEntityException
StoreIsInactiveException

}

Implements StoreRepositoryInterface.

Definition at line 125 of file StoreRepository.php.

    {
        $store = $this->getById($id);

        if (!$store->isActive()) {
            throw new StoreIsInactiveException();
        }
        return $store;
    }

getById()

getById

(

$id

)

{Retrieve store by id

Parameters

int

$id

Returns

\Magento\Store\Api\Data\StoreInterface

Exceptions

NoSuchEntityException

}

Implements StoreRepositoryInterface.

Definition at line 100 of file StoreRepository.php.

    {
        if (isset($this->entitiesById[$id])) {
            return $this->entitiesById[$id];
        }

        $storeData = $this->getAppConfig()->get('scopes', "stores/$id", []);
        $store = $this->storeFactory->create([
            'data' => $storeData
        ]);

        if ($store->getId() === null) {
            throw new NoSuchEntityException(
                __("The store that was requested wasn't found. Verify the store and try again.")
            );
        }

        $this->entitiesById[$id] = $store;
        $this->entities[$store->getCode()] = $store;
        return $store;
    }

getList()

getList

(

)

{Retrieve list of all stores

Returns

\Magento\Store\Api\Data\StoreInterface[]

}

Implements StoreRepositoryInterface.

Definition at line 138 of file StoreRepository.php.

    {
        if ($this->allLoaded) {
            return $this->entities;
        }
        $stores = $this->getAppConfig()->get('scopes', "stores", []);
        foreach ($stores as $data) {
            $store = $this->storeFactory->create([
                'data' => $data
            ]);
            $this->entities[$store->getCode()] = $store;
            $this->entitiesById[$store->getId()] = $store;
        }
        $this->allLoaded = true;
        return $this->entities;
    }

Field Documentation

$allLoaded

$allLoaded = false

protected

Definition at line 41 of file StoreRepository.php.

$entities

$entities = []

protected

Definition at line 31 of file StoreRepository.php.

$entitiesById

$entitiesById = []

protected

Definition at line 36 of file StoreRepository.php.

$storeCollectionFactory

$storeCollectionFactory

protected

Definition at line 26 of file StoreRepository.php.

$storeFactory

$storeFactory

protected

Definition at line 21 of file StoreRepository.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-store/Model/StoreRepository.php