Stores

Type: Class
Namespace: craft\commerce\services
Inherits: craft\commerce\services\Stores » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 5.0.0

Stores service.

Public Properties

Property	Description
allSiteStores	`\Illuminate\Support\Collection<\craft\commerce\models\SiteStore>`
allStores	`\Illuminate\Support\Collection`
behaviors	yii\base\Behavior – List of behaviors attached to this component.
currentStore	craft\commerce\models\Store – The current store
primaryStore	craft\commerce\models\Store
siteIdsAvailableForAssignmentToNewStores	array

`allSiteStores`

Type: \Illuminate\Support\Collection<\craft\commerce\models\SiteStore>
Default value: null
Access: Read-only

View source

`allStores`

Type: \Illuminate\Support\Collection
Default value: null

View source

`currentStore`

Type: craft\commerce\models\Store
Default value: null
Access: Read-only

The current store

View source

`primaryStore`

Type: craft\commerce\models\Store
Default value: null

View source

`siteIdsAvailableForAssignmentToNewStores`

Type: array
Default value: null
Access: Read-only

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
afterDeleteCraftSiteHandler()
afterSaveCraftSiteHandler()
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
deleteStore()
deleteStoreById()
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
getAllSiteStores()
getAllSitesForStore()
getAllStores()
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getCurrentStore()	Returns the current store.
getPrimaryStore()	Returns the primary store.
getSiteIdsAvailableForAssignmentToNewStores()	Returns sites that are assigned to more than one store assigned, so that other new stores can use them.
getStoreByHandle()
getStoreById()
getStoreBySiteId()
getStoreByUid()
getStoresByUserId()	Returns a collections of stores that are available to a user.
handleChangedSiteStore()	Handle site store mapping change.
handleChangedStore()	Handle store status change.
handleDeletedSiteStore()	Handle a deleted Store.
handleDeletedStore()	Handle a deleted Store.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
refreshStores()	Refresh the status of all stores based on the DB data.
reorderStores()
saveSiteStore()
saveStore()	Saves a store.
trigger()	Triggers an event.