Inheritance diagram for Group:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Config\Model\ResourceModel\Config\Data $configDataResource, \Magento\Store\Model\ResourceModel\Store\CollectionFactory $storeListFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Framework\Event\ManagerInterface $eventManager=null)

	setStores ($stores)

	getStoreCollection ()

	getStores ()

	getStoreIds ()

	getStoreCodes ()

	getStoresCount ()

	getDefaultStore ()

	getDefaultStoreByLocale ($locale)

	getStoresByLocale ($locale)

	setWebsite (Website $website)

	getWebsite ()

	isCanDelete ()

	getDefaultStoreId ()

	setDefaultStoreId ($defaultStoreId)

	getRootCategoryId ()

	setRootCategoryId ($rootCategoryId)

	getWebsiteId ()

	setWebsiteId ($websiteId)

	beforeDelete ()

	afterDelete ()

	afterSave ()

	isReadOnly ($value=null)

	getIdentities ()

	getName ()

	setName ($name)

	getCode ()

	setCode ($code)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Store\Api\Data\GroupExtensionInterface $extensionAttributes)

	getScopeType ()

	getScopeTypeName ()

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from GroupInterface
	getId ()

	setId ($id)

	setExtensionAttributes (\Magento\Store\Api\Data\GroupExtensionInterface $extensionAttributes)

Public Member Functions inherited from ScopeInterface
	getId ()

Data Fields
const	ENTITY = 'store_group'

const	CACHE_TAG = 'store_group'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from ScopeInterface
const	SCOPE_DEFAULT = 'default'

Protected Member Functions
	_construct ()

	_loadStores ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_cacheTag = true

	$_eventPrefix = 'store_group'

	$_eventObject = 'store_group'

	$_stores

	$_storeIds = []

	$_storeCodes = []

	$_storesCount = 0

	$_defaultStore

	$_configDataResource

	$_storeListFactory

	$_storeManager

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Class Group

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 19 of file Group.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory,
		\Magento\Config\Model\ResourceModel\Config\Data	$configDataResource,
		\Magento\Store\Model\ResourceModel\Store\CollectionFactory	$storeListFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		\Magento\Framework\Event\ManagerInterface	$eventManager = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory
\Magento\Config\Model\ResourceModel\Config\Data	$configDataResource
\Magento\Store\Model\Store	$store
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
\Magento\Framework\Event\ManagerInterface \| null	$eventManager	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 117 of file Group.php.

       {
         $this->_configDataResource = $configDataResource;
         $this->_storeListFactory = $storeListFactory;
         $this->_storeManager = $storeManager;
         $this->eventManager = $eventManager ?: \Magento\Framework\App\ObjectManager::getInstance()
             ->get(\Magento\Framework\Event\ManagerInterface::class);
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Init model

Returns: void

Definition at line 151 of file Group.php.

     {
         $this->_init(\Magento\Store\Model\ResourceModel\Group::class);
     }

◆ _loadStores()

_loadStores ( )

protected

Load store collection and set internal data

Returns: void

Definition at line 161 of file Group.php.

     {
         $this->_stores = [];
         $this->_storesCount = 0;
         foreach ($this->getStoreCollection() as $store) {
             $this->_stores[$store->getId()] = $store;
             $this->_storeIds[$store->getId()] = $store->getId();
             $this->_storeCodes[$store->getId()] = $store->getCode();
             if ($this->getDefaultStoreId() == $store->getId()) {
                 $this->_defaultStore = $store;
             }
             $this->_storesCount++;
         }
     }

◆ afterDelete()

afterDelete ( )

Since: 100.1.0

Definition at line 415 of file Group.php.

     {
         $group = $this;
         $this->getResource()->addCommitCallback(function () use ($group) {
             $this->_storeManager->reinitStores();
             $this->eventManager->dispatch($this->_eventPrefix . '_delete', ['group' => $group]);
         });
         $result = parent::afterDelete();
 
         if ($this->getId() === $this->getWebsite()->getDefaultGroupId()) {
             $ids = $this->getWebsite()->getGroupIds();
             if (!empty($ids) && count($ids) > 1) {
                 unset($ids[$this->getId()]);
                 $defaultId = current($ids);
             } else {
                 $defaultId = null;
             }
             $this->getWebsite()->setDefaultGroupId($defaultId);
             $this->getWebsite()->save();
         }
         return $result;
     }

◆ afterSave()

afterSave ( )

Since: 100.2.5

Definition at line 442 of file Group.php.

     {
         $group = $this;
         $this->getResource()->addCommitCallback(function () use ($group) {
             $this->_storeManager->reinitStores();
             $this->eventManager->dispatch($this->_eventPrefix . '_save', ['group' => $group]);
         });
         return parent::afterSave();
     }

◆ beforeDelete()

beforeDelete ( )

Returns: $this

Definition at line 402 of file Group.php.

     {
         $this->_configDataResource->clearScopeData(
             \Magento\Store\Model\ScopeInterface::SCOPE_STORES,
             $this->getStoreIds()
         );
         return parent::beforeDelete();
     }

◆ getCode()

getCode ( )

Retrieve scope code

Returns: string

Since: 100.1.0

Implements ScopeInterface.

Definition at line 496 of file Group.php.

     {
         return $this->getData('code');
     }

◆ getDefaultStore()

getDefaultStore ( )

Retrieve default store model

Returns: \Magento\Store\Model\Store

Definition at line 262 of file Group.php.

     {
         if (!$this->hasDefaultStoreId()) {
             return false;
         }
         if ($this->_stores === null) {
             $this->_loadStores();
         }
         return $this->_defaultStore;
     }

◆ getDefaultStoreByLocale()

getDefaultStoreByLocale ( $locale )

Get most suitable store by locale If no store with given locale is found - default store is returned If group has no stores - null is returned

Parameters

string $locale

Returns: \Magento\Store\Model\Store|null

Definition at line 281 of file Group.php.

     {
         if ($this->getDefaultStore() && $this->getDefaultStore()->getLocaleCode() == $locale) {
             return $this->getDefaultStore();
         } else {
             $stores = $this->getStoresByLocale($locale);
             if (count($stores)) {
                 return $stores[0];
             } else {
                 return $this->getDefaultStore() ? $this->getDefaultStore() : null;
             }
         }
     }

◆ getDefaultStoreId()

getDefaultStoreId ( )

Returns: mixed

Implements GroupInterface.

Definition at line 354 of file Group.php.

     {
         return $this->_getData('default_store_id');
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Store\Api\Data\GroupExtensionInterface|null

}

Implements GroupInterface.

Definition at line 513 of file Group.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getIdentities()

getIdentities ( )

Get identities

Returns: array

Implements IdentityInterface.

Definition at line 471 of file Group.php.

     {
         return [self::CACHE_TAG];
     }

◆ getName()

getName ( )

{Get scope name

Returns: string

Since: 100.1.0

}

Implements ScopeInterface.

Definition at line 479 of file Group.php.

     {
         return $this->getData('name');
     }

◆ getRootCategoryId()

getRootCategoryId ( )

Returns: mixed

Implements GroupInterface.

Definition at line 370 of file Group.php.

     {
         return $this->_getData('root_category_id');
     }

◆ getScopeType()

getScopeType ( )

{Get scope type

Returns: string

Since: 100.1.0

}

Since: 100.1.0

Implements ScopeInterface.

Definition at line 531 of file Group.php.

     {
         return ScopeInterface::SCOPE_GROUP;
     }

◆ getScopeTypeName()

getScopeTypeName ( )

{Get scope type name

Returns: string

Since: 100.1.0

}

Since: 100.1.0

Implements ScopeInterface.

Definition at line 540 of file Group.php.

     {
         return 'Store';
     }

◆ getStoreCodes()

getStoreCodes ( )

Retrieve website store codes

Returns: array

Definition at line 238 of file Group.php.

     {
         if ($this->_stores === null) {
             $this->_loadStores();
         }
         return $this->_storeCodes;
     }

◆ getStoreCollection()

getStoreCollection ( )

Retrieve new (not loaded) Store collection object with group filter

Returns: \Magento\Store\Model\ResourceModel\Store\Collection

Definition at line 202 of file Group.php.

     {
         return $this->_storeListFactory->create()->addGroupFilter($this->getId());
     }

◆ getStoreIds()

getStoreIds ( )

Retrieve website store ids

Returns: int[]

Definition at line 225 of file Group.php.

     {
         if ($this->_stores === null) {
             $this->_loadStores();
         }
         return $this->_storeIds;
     }

◆ getStores()

getStores ( )

Retrieve website store objects

Returns: \Magento\Store\Model\ResourceModel\Store\Collection[]

Definition at line 212 of file Group.php.

     {
         if ($this->_stores === null) {
             $this->_loadStores();
         }
         return $this->_stores;
     }

◆ getStoresByLocale()

getStoresByLocale ( $locale )

Retrieve list of stores with given locale

Parameters

string $locale

Returns: \Magento\Store\Model\Store[]

Definition at line 301 of file Group.php.

     {
         $stores = [];
         foreach ($this->getStores() as $store) {
             /* @var $store \Magento\Store\Model\Store */
             if ($store->getLocaleCode() == $locale) {
                 $stores[] = $store;
             }
         }
         return $stores;
     }

◆ getStoresCount()

getStoresCount ( )

Returns: int

Definition at line 249 of file Group.php.

     {
         if ($this->_stores === null) {
             $this->_loadStores();
         }
         return $this->_storesCount;
     }

◆ getWebsite()

getWebsite ( )

Retrieve website model

Returns: Website|bool

Definition at line 329 of file Group.php.

     {
         if ($this->getWebsiteId() === null) {
             return false;
         }
         return $this->_storeManager->getWebsite($this->getWebsiteId());
     }

◆ getWebsiteId()

getWebsiteId ( )

Returns: mixed

Implements GroupInterface.

Definition at line 386 of file Group.php.

     {
         return $this->_getData('website_id');
     }

◆ isCanDelete()

isCanDelete ( )

Is can delete group

Returns: bool

Definition at line 342 of file Group.php.

     {
         if (!$this->getId()) {
             return false;
         }
 
         return $this->getWebsite()->getGroupsCount() > 1;
     }

◆ isReadOnly()

isReadOnly ( $value = null )

Get/Set isReadOnly flag

Parameters

bool $value

Returns: bool

Definition at line 458 of file Group.php.

     {
         if (null !== $value) {
             $this->_isReadOnly = (bool)$value;
         }
         return $this->_isReadOnly;
     }

◆ setCode()

setCode ( $code )

Sets group code.

Parameters

string $code

Returns: $this

Since: 100.2.0

Since: 100.2.0

Implements GroupInterface.

Definition at line 505 of file Group.php.

     {
         return $this->setData('code', $code);
     }

◆ setDefaultStoreId()

setDefaultStoreId ( $defaultStoreId )

Parameters

int $defaultStoreId

Returns: $this

Implements GroupInterface.

Definition at line 362 of file Group.php.

     {
         return $this->setData('default_store_id', $defaultStoreId);
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Store\Api\Data\GroupExtensionInterface $extensionAttributes )

{}

Definition at line 521 of file Group.php.

       {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

◆ setName()

setName ( $name )

Parameters

string $name

Returns: $this

Implements GroupInterface.

Definition at line 487 of file Group.php.

     {
         return $this->setData('name', $name);
     }

◆ setRootCategoryId()

setRootCategoryId ( $rootCategoryId )

Parameters

int $rootCategoryId

Returns: $this

Implements GroupInterface.

Definition at line 378 of file Group.php.

     {
         return $this->setData('root_category_id', $rootCategoryId);
     }

◆ setStores()

setStores ( $stores )

Set website stores

Parameters

Definition at line 182 of file Group.php.

     {
         $this->_stores = [];
         $this->_storesCount = 0;
         foreach ($stores as $store) {
             $this->_stores[$store->getId()] = $store;
             $this->_storeIds[$store->getId()] = $store->getId();
             $this->_storeCodes[$store->getId()] = $store->getCode();
             if ($this->getDefaultStoreId() == $store->getId()) {
                 $this->_defaultStore = $store;
             }
             $this->_storesCount++;
         }
     }

◆ setWebsite()

setWebsite ( Website $website )

Set relation to the website

Parameters

Website $website

Returns: void

Definition at line 319 of file Group.php.

     {
         $this->setWebsiteId($website->getId());
     }

◆ setWebsiteId()

setWebsiteId ( $websiteId )

Parameters

int $websiteId

Returns: $this

Implements GroupInterface.

Definition at line 394 of file Group.php.

     {
         return $this->setData('website_id', $websiteId);
     }

Field Documentation

◆ $_cacheTag

$_cacheTag = true

protected

Definition at line 31 of file Group.php.

◆ $_configDataResource

$_configDataResource

protected

Definition at line 86 of file Group.php.

◆ $_defaultStore

$_defaultStore

protected

Definition at line 76 of file Group.php.

◆ $_eventObject

$_eventObject = 'store_group'

protected

Definition at line 41 of file Group.php.

◆ $_eventPrefix

$_eventPrefix = 'store_group'

protected

Definition at line 36 of file Group.php.

◆ $_storeCodes

$_storeCodes = []

protected

Definition at line 62 of file Group.php.

◆ $_storeIds

$_storeIds = []

protected

Definition at line 55 of file Group.php.

◆ $_storeListFactory

$_storeListFactory

protected

Definition at line 91 of file Group.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 96 of file Group.php.

◆ $_stores

$_stores

protected

Definition at line 48 of file Group.php.

◆ $_storesCount

$_storesCount = 0

protected

Definition at line 69 of file Group.php.

◆ CACHE_TAG

const CACHE_TAG = 'store_group'

Definition at line 26 of file Group.php.

◆ ENTITY

const ENTITY = 'store_group'

Definition at line 24 of file Group.php.

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

vendor/magento/module-store/Model/Group.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _loadStores()

◆ afterDelete()

◆ afterSave()

◆ beforeDelete()

◆ getCode()

◆ getDefaultStore()

◆ getDefaultStoreByLocale()

◆ getDefaultStoreId()

◆ getExtensionAttributes()

◆ getIdentities()

◆ getName()

◆ getRootCategoryId()

◆ getScopeType()

◆ getScopeTypeName()

◆ getStoreCodes()

◆ getStoreCollection()

◆ getStoreIds()

◆ getStores()

◆ getStoresByLocale()

◆ getStoresCount()

◆ getWebsite()

◆ getWebsiteId()

◆ isCanDelete()

◆ isReadOnly()

◆ setCode()

◆ setDefaultStoreId()

◆ setExtensionAttributes()

◆ setName()

◆ setRootCategoryId()

◆ setStores()

◆ setWebsite()

◆ setWebsiteId()

Field Documentation

◆ $_cacheTag

◆ $_configDataResource

◆ $_defaultStore

◆ $_eventObject

◆ $_eventPrefix

◆ $_storeCodes

◆ $_storeIds

◆ $_storeListFactory

◆ $_storeManager

◆ $_stores

◆ $_storesCount

◆ CACHE_TAG

◆ ENTITY