InventoryLocations ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\InventoryLocations » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 5.0
Inventory Locations service.
Public Properties ​
| Property | Description |
|---|---|
| allInventoryLocations | \Illuminate\Support\Collection – All locations |
| allInventoryLocationsAsList | array – All locations as key value list |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| inventoryLocations | \Illuminate\Support\Collection<\craft\commerce\models\InventoryLocation> |
allInventoryLocations ​
- Type
\Illuminate\Support\Collection- Default value
null- Access
- Read-only
All locations
allInventoryLocationsAsList ​
- Type
- array
- Default value
null- Access
- Read-only
- Since
- 5.1.0
All locations as key value list
inventoryLocations ​
- Type
\Illuminate\Support\Collection<\craft\commerce\models\InventoryLocation>- Default value
null- Access
- Read-only
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. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| authorizeInventoryLocationAddressEdit() | |
| authorizeInventoryLocationAddressView() | |
| 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. |
| 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. |
| executeDeactivateInventoryLocation() | |
| getAllInventoryLocations() | Returns all inventory locations. |
| getAllInventoryLocationsAsList() | Returns all inventory locations as a list. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getInventoryLocationByHandle() | Returns a location by its handle. |
| getInventoryLocationById() | Returns an inventory location by its ID. |
| getInventoryLocations() | Gets all inventory locations for a store in order of configuration. |
| 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. |
| saveInventoryLocation() | Saves an inventory location. |
| saveStoreInventoryLocations() | Stores the relationship between a Store and its Inventory Locations, ordered by preference. |
| trigger() | Triggers an event. |
authorizeInventoryLocationAddressEdit() ​
Arguments ​
$event
authorizeInventoryLocationAddressView() ​
Arguments ​
$event(craft\events\AuthorizationCheckEvent)
Returns ​
void
executeDeactivateInventoryLocation() ​
Arguments ​
$deactivateInventoryLocation
Returns ​
Throws ​
getAllInventoryLocations() ​
Returns all inventory locations.
Arguments ​
$withTrashed(boolean)
Returns ​
\Illuminate\Support\Collection – All locations
Throws ​
getAllInventoryLocationsAsList() ​
- Since
- 5.1.0
Returns all inventory locations as a list.
Arguments ​
$withTrashed(boolean)
Returns ​
array – All locations as key value list
Throws ​
getInventoryLocationByHandle() ​
Returns a location by its handle.
Arguments ​
$handle(string)
Returns ​
craft\commerce\models\InventoryLocation, null – The location or null if not found.
Throws ​
getInventoryLocationById() ​
Returns an inventory location by its ID.
Arguments ​
Returns ​
craft\commerce\models\InventoryLocation, null – The inventory location or null if not found.
getInventoryLocations() ​
Gets all inventory locations for a store in order of configuration.
Arguments ​
$storeId(?int)$withTrashed
Returns ​
\Illuminate\Support\Collection<\craft\commerce\models\InventoryLocation>
saveInventoryLocation() ​
Saves an inventory location.
Arguments ​
$inventoryLocation$runValidation
saveStoreInventoryLocations() ​
Stores the relationship between a Store and its Inventory Locations, ordered by preference.
Arguments ​
$store(craft\commerce\models\Store)$inventoryLocationIds(array)