Inventory

Type

Class

Namespace

craft\commerce\services

Inherits

craft\commerce\services\Inventory » yii\base\Component » yii\base\BaseObject

Implements

yii\base\Configurable

Since

5.0.0

Inventory service.

View source

Public Properties

Property	Description
behaviors	yii\base\Behavior – List of behaviors attached to this component.
inventoryItemQuery	craft\db\Query
inventoryLevelQuery	craft\db\Query
movementHash	string
transactionQuery	craft\db\Query

inventoryItemQuery

Type

craft\db\Query

Default value

null

Access

Read-only

View source

inventoryLevelQuery

Type

craft\db\Query

Default value

null

Access

Read-only

View source

movementHash

Type

string

Default value

null

Access

Read-only

View source

transactionQuery

Type

craft\db\Query

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.
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.
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.
ensureInventoryItemRecord()	Finds or creates the inventory item record for the given purchasable, always keyed by its canonical id so drafts and revisions resolve to the same row as their canonical. Returns null if the purchasable type does not track inventory or there is no canonical id yet.
executeInventoryMovements()
executeUpdateInventoryLevels()
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getInventoryFulfillmentLevels()
getInventoryItemById()
getInventoryItemByPurchasable()
getInventoryItemQuery()
getInventoryItemsByIds()
getInventoryLevel()	Returns an inventory level model which is the sum of all inventory movements types for an item in a location.
getInventoryLevelQuery()	Returns the totals for inventory items grouped by location and purchasable/inventoryItem.
getInventoryLevelsForPurchasable()
getInventoryLocationLevels()
getInventoryTransactions()
getMovementHash()
getTransactionQuery()
getUnfulfilledOrders()
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.
orderCompleteHandler()
saveInventoryItem()
trigger()	Triggers an event.
updateInventoryLevel()
updatePurchasableInventoryLevel()

ensureInventoryItemRecord()

Since

5.6.4

Finds or creates the inventory item record for the given purchasable, always keyed by its canonical id so drafts and revisions resolve to the same row as their canonical. Returns null if the purchasable type does not track inventory or there is no canonical id yet.

View source

Arguments

• $purchasable (craft\commerce\base\Purchasable)

Returns

craft\commerce\records\InventoryItem, null

executeInventoryMovements()

View source

Arguments

• $inventoryMovements (craft\commerce\collections\InventoryMovementCollection)

Returns

boolean

Throws

• yii\db\Exception

executeUpdateInventoryLevels()

View source

Arguments

• $updateInventoryLevels (craft\commerce\collections\UpdateInventoryLevelCollection)

Returns

boolean

Throws

• yii\db\Exception

getInventoryFulfillmentLevels()

View source

Arguments

• $order (craft\commerce\elements\Order)

Returns

\Illuminate\Support\Collection<\craft\commerce\models\InventoryFulfillmentLevel>

Throws

• yii\base\InvalidConfigException
• craft\errors\DeprecationException

getInventoryItemById()

View source

Arguments

• $id (integer)

Returns

craft\commerce\models\InventoryItem

getInventoryItemByPurchasable()

View source

Arguments

• $purchasable (craft\commerce\base\Purchasable)

Returns

craft\commerce\models\InventoryItem

getInventoryItemQuery()

View source

Returns

craft\db\Query

getInventoryItemsByIds()

View source

Arguments

• $ids (integer[])

Returns

\Illuminate\Support\Collection<\craft\commerce\models\InventoryItem>

getInventoryLevel()

Returns an inventory level model which is the sum of all inventory movements types for an item in a location.

View source

Arguments

• $inventoryItem (craft\commerce\models\InventoryItem, integer)
• $inventoryLocation (craft\commerce\models\InventoryLocation, integer)
• $withTrashed (boolean)

Returns

?\craft\commerce\models\InventoryLevel

getInventoryLevelQuery()

Returns the totals for inventory items grouped by location and purchasable/inventoryItem.

View source

Arguments

• $limit (integer, null)
• $offset (integer, null)
• $withTrashed (boolean)

Returns

craft\db\Query

getInventoryLevelsForPurchasable()

View source

Arguments

• $purchasable (craft\commerce\base\Purchasable)

Returns

\Illuminate\Support\Collection<\craft\commerce\models\InventoryLevel>

getInventoryLocationLevels()

View source

Arguments

• $inventoryLocation (craft\commerce\models\InventoryLocation)
• $withTrashed (boolean)

Returns

\Illuminate\Support\Collection

Throws

• yii\base\InvalidConfigException

getInventoryTransactions()

View source

Arguments

• $inventoryItem (craft\commerce\models\InventoryItem)
• $inventoryLocation (craft\commerce\models\InventoryLocation)

Returns

\Illuminate\Support\Collection

getMovementHash()

View source

Returns

string

getTransactionQuery()

View source

Returns

craft\db\Query

getUnfulfilledOrders()

View source

Arguments

• $inventoryItem (craft\commerce\models\InventoryItem, integer)
• $inventoryLocation (craft\commerce\models\InventoryLocation, integer)

Returns

array

orderCompleteHandler()

View source

Arguments

• $order (craft\commerce\elements\Order)

Returns

void

Throws

• yii\base\InvalidConfigException
• yii\db\Exception

saveInventoryItem()

View source

Arguments

• $inventoryItem (craft\commerce\models\InventoryItem)
• $validate (boolean)

Returns

boolean

Throws

• yii\base\InvalidConfigException

updateInventoryLevel()

Since

5.3.0

View source

Arguments

• $inventoryItemId (integer)
• $quantity (integer)
• $updateInventoryLevelAttributes (array)

Returns

void

Throws

• yii\db\Exception
• yii\base\InvalidConfigException

updatePurchasableInventoryLevel()

Since

5.3.0

View source

Arguments

• $purchasable (craft\commerce\base\Purchasable)
• $quantity (integer)
• $updateInventoryLevelAttributes (array)

Returns

void

Throws

• yii\db\Exception
• yii\base\InvalidConfigException
• craft\errors\DeprecationException

Events

EVENT_AFTER_EXECUTE_INVENTORY_MOVEMENT

Type

craft\commerce\events\InventoryMovementEvent

The event that is triggered after an inventory movement is executed.

use craft\commerce\events\InventoryMovementEvent;
use craft\commerce\services\Inventory;
use craft\commerce\base\InventoryMovementInterface;
use yii\base\Event;

Event::on(
    Inventory::class,
    Inventory::EVENT_AFTER_EXECUTE_INVENTORY_MOVEMENT,
    function(InventoryMovementEvent $event) {
        // @var InventoryMovementInterface $inventoryMovement
        $inventoryMovement = $event->inventoryMovement;
    }
);

---

EVENT_AFTER_EXECUTE_UPDATE_INVENTORY_LEVEL

Type

craft\commerce\events\UpdateInventoryLevelEvent

The event that is triggered after an inventory level update is executed.

use craft\commerce\events\UpdateInventoryLevelEvent;
use craft\commerce\services\Inventory;
use craft\commerce\models\inventory\UpdateInventoryLevel;
use yii\base\Event;

Event::on(
    Inventory::class,
    Inventory::EVENT_AFTER_EXECUTE_UPDATE_INVENTORY_LEVEL,
    function(UpdateInventoryLevelEvent $event) {
        // @var UpdateInventoryLevel $updateInventoryLevel
        $updateInventoryLevel = $event->updateInventoryLevel;
    }
);

---