LineItem

Type: Class
Namespace: craft\commerce\models
Inherits: craft\commerce\models\LineItem » craft\commerce\base\Model » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ModelInterface (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits: craft\base\ClonefixTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since: 2.0

Line Item model representing a line item on an order.

# Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
adjustments	array (opens new window), craft\commerce\models\OrderAdjustment[]
adjustmentsTotal
adjustmentsTotalAsCurrency	string (opens new window)
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
dateCreated	DateTime (opens new window), null (opens new window)
dateUpdated	DateTime (opens new window), null (opens new window)
description	string (opens new window)
discount	float (opens new window)
discountAsCurrency	string (opens new window)
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window)	array (opens new window) – The first errors.
height	float (opens new window) – Height
id	integer (opens new window), null (opens new window) – ID
isShippable
isTaxable
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
length	float (opens new window) – Length
lineItemStatus
lineItemStatusId	integer (opens new window), null (opens new window) – Line Item Status ID
note	string (opens new window) – Note
onSale	boolean (opens new window)
options	array (opens new window)
optionsSignature	string (opens new window) – the unique hash of the options
order	craft\commerce\elements\Order
orderId	integer (opens new window), null (opens new window) – Order ID
price	float (opens new window)
priceAsCurrency	string (opens new window)
privateNote	string (opens new window) – Private Note
purchasable	craft\commerce\base\Purchasable
purchasableId	integer (opens new window), null (opens new window) – Purchasable ID
qty	integer (opens new window) – Quantity
saleAmount	float (opens new window)
saleAmountAsCurrency	string (opens new window)
salePrice	float (opens new window)
salePriceAsCurrency	string (opens new window)
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
shippingCategory	craft\commerce\models\ShippingCategory
shippingCategoryId	integer (opens new window) – Shipping category ID
shippingCost	integer (opens new window)
shippingCostAsCurrency	string (opens new window)
sku	string (opens new window)
snapshot	`mixed` – Snapshot
subtotal	float (opens new window) – the Purchasable’s sale price multiplied by the quantity of the line item
subtotalAsCurrency	string (opens new window)
tax	integer (opens new window)
taxAsCurrency	string (opens new window)
taxCategory	craft\commerce\models\TaxCategory
taxCategoryId	integer (opens new window) – Tax category ID
taxIncluded	integer (opens new window)
taxIncludedAsCurrency	string (opens new window)
total	float (opens new window) – the subTotal plus any adjustments belonging to this line item
totalAsCurrency	string (opens new window)
uid	string (opens new window) – UID
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
weight	float (opens new window) – Weight
width	float (opens new window) – Width

# `adjustments`

Type: array (opens new window), craft\commerce\models\OrderAdjustment[]
Default value: null

View source (opens new window)

# `adjustmentsTotal`

Default value: null
Access: Read-only

View source (opens new window)

# `adjustmentsTotalAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `dateCreated`

Type: DateTime (opens new window), null (opens new window)
Default value: null
Since: 2.2

View source (opens new window)

# `dateUpdated`

Type: DateTime (opens new window), null (opens new window)
Default value: null
Since: 3.2.0

View source (opens new window)

# `description`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `discount`

Type: float (opens new window)
Default value: null

View source (opens new window)

# `discountAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `height`

Type: float (opens new window)
Default value: 0

Height

View source (opens new window)

# `id`

Type: integer (opens new window), null (opens new window)
Default value: null

View source (opens new window)

# `isShippable`

Default value: null
Access: Read-only
Since: 3.4

View source (opens new window)

# `isTaxable`

Default value: null
Access: Read-only
Since: 3.3.4

View source (opens new window)

# `length`

Type: float (opens new window)
Default value: 0

Length

View source (opens new window)

# `lineItemStatus`

Default value: null
Access: Read-only

View source (opens new window)

# `lineItemStatusId`

Type: integer (opens new window), null (opens new window)
Default value: null

Line Item Status ID

View source (opens new window)

# `note`

Type: string (opens new window)
Default value: ''

Note

View source (opens new window)

# `onSale`

Type: boolean (opens new window)
Default value: null

View source (opens new window)

# `options`

Type: array (opens new window)
Default value: null

View source (opens new window)

# `optionsSignature`

Type: string (opens new window)
Default value: null

the unique hash of the options

View source (opens new window)

# `order`

Type: craft\commerce\elements\Order
Default value: null

View source (opens new window)

# `orderId`

Type: integer (opens new window), null (opens new window)
Default value: null

Order ID

View source (opens new window)

# `price`

Type: float (opens new window)
Default value: null

View source (opens new window)

# `priceAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `privateNote`

Type: string (opens new window)
Default value: ''

Private Note

View source (opens new window)

# `purchasable`

Type: craft\commerce\base\Purchasable
Default value: null

View source (opens new window)

# `purchasableId`

Type: integer (opens new window), null (opens new window)
Default value: null

Purchasable ID

View source (opens new window)

# `qty`

Type: integer (opens new window)
Default value: null

Quantity

View source (opens new window)

# `saleAmount`

Type: float (opens new window)
Default value: null

View source (opens new window)

# `saleAmountAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `salePrice`

Type: float (opens new window)
Default value: null

View source (opens new window)

# `salePriceAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `shippingCategory`

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

View source (opens new window)

# `shippingCategoryId`

Type: integer (opens new window)
Default value: null

Shipping category ID

View source (opens new window)

# `shippingCost`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `shippingCostAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `sku`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `snapshot`

Type: mixed
Default value: null

Snapshot

View source (opens new window)

# `subtotal`

Type: float (opens new window)
Default value: null

the Purchasable’s sale price multiplied by the quantity of the line item

View source (opens new window)

# `subtotalAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `tax`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `taxAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `taxCategory`

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

View source (opens new window)

# `taxCategoryId`

Type: integer (opens new window)
Default value: null

Tax category ID

View source (opens new window)

# `taxIncluded`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `taxIncludedAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `total`

Type: float (opens new window)
Default value: null

the subTotal plus any adjustments belonging to this line item

View source (opens new window)

# `totalAsCurrency`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `uid`

Type: string (opens new window)
Default value: null

UID

View source (opens new window)

# `weight`

Type: float (opens new window)
Default value: 0

Weight

View source (opens new window)

# `width`

Type: float (opens new window)
Default value: 0

Width

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)
__construct() (opens new window)
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors() (opens new window)	Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeValidate() (opens new window)	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
currencyAttributes()	The attributes on the order that should be made available as formatted currency.
datetimeAttributes() (opens new window)	Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields()	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAdjustments()
getAdjustmentsTotal()
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getDescription()
getDiscount()
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getIsShippable()
getIsTaxable()
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getLineItemStatus()
getOnSale()
getOptions()	Returns the options for the line item.
getOptionsSignature()	Returns a unique hash of the line item options
getOrder()
getPrice()
getPurchasable()
getSaleAmount()
getSalePrice()
getScenario() (opens new window)	Returns the scenario that this model is used in.
getShippingCategory()
getShippingCost()
getSku()
getSubtotal()
getTax()
getTaxCategory()
getTaxIncluded()
getTaxableSubtotal()
getTotal()	Returns the Purchasable’s sale price multiplied by the quantity of the line item, plus any adjustment belonging to this lineitem.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
populateFromPurchasable()
refreshFromPurchasable()
rules() (opens new window)	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
setAttributes() (opens new window)	Sets the attribute values in a massive way.
setDescription()
setLineItemStatus()
setOptions()	Set the options array on the line item.
setOrder()
setPrice()
setPurchasable()
setSalePrice()
setScenario() (opens new window)	Sets the scenario for the model.
setSku()
toArray() (opens new window)	Converts the model into an array.
trigger() (opens new window)	Triggers an event.
validate() (opens new window)	Performs the data validation.
validateMultiple() (opens new window)	Validates multiple models.

# `attributes()`

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source (opens new window)

Returns

string (opens new window)[] – List of attribute names.

# `behaviors()`

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\commerce\models\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() (opens new window) or be detached using detachBehavior() (opens new window). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source (opens new window)

Returns

array (opens new window) – The behavior configurations.

# `currencyAttributes()`

The attributes on the order that should be made available as formatted currency.

View source (opens new window)

# `extraFields()`

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source (opens new window)

Returns

array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

# `fields()`

Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.

A field is a named element in the returned array by toArray() (opens new window).

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

email: the field name is the same as the property name email;
firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.

return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function () {
        return $this->first_name . ' ' . $this->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

The default implementation of this method returns the public object member variables indexed by themselves.

View source (opens new window)

Returns

array (opens new window) – The list of field names or field definitions.

Arguments

$included

Throws

yii\base\InvalidConfigException (opens new window)

# `getDescription()`

View source (opens new window)

Returns

string (opens new window)

# `getDiscount()`

View source (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `getIsShippable()`

Since: 3.4

View source (opens new window)

# `getIsTaxable()`

Since: 3.3.4

View source (opens new window)

# `getLineItemStatus()`

View source (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `getOnSale()`

View source (opens new window)

# `getOptions()`

Returns the options for the line item.

View source (opens new window)

# `getOptionsSignature()`

Returns a unique hash of the line item options

View source (opens new window)

# `getOrder()`

View source (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `getPrice()`

Since: 3.1.1

View source (opens new window)

# `getPurchasable()`

View source (opens new window)

# `getSaleAmount()`

Since: 3.1.1

yii\base\InvalidConfigException (opens new window)

# `getTaxableSubtotal()`

View source (opens new window)

Arguments

$taxable

# `getTotal()`

Returns the Purchasable’s sale price multiplied by the quantity of the line item, plus any adjustment belonging to this lineitem.

View source (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `init()`

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source (opens new window)

# `populateFromPurchasable()`

View source (opens new window)

Arguments

$purchasable

Throws

yii\base\InvalidConfigException (opens new window)

# `refreshFromPurchasable()`

View source (opens new window)

Returns

boolean (opens new window) – False when no related purchasable exists

Throws

yii\base\InvalidConfigException (opens new window)

# `setDescription()`

View source (opens new window)

Arguments

$description (?string)

Returns

void

# `setLineItemStatus()`

Since: 3.2.2

View source (opens new window)

Arguments

$status (craft\commerce\models\LineItemStatus, null (opens new window))

# `setOptions()`

Set the options array on the line item.

View source (opens new window)

Arguments

$options

# `setOrder()`

View source (opens new window)

Arguments

$order

# `setPrice()`

Since: 3.1.1

View source (opens new window)

Arguments

$price

# `setPurchasable()`

View source (opens new window)

Arguments

$purchasable

# `setSalePrice()`

Since: 3.1.1

View source (opens new window)

Arguments

$salePrice

# `setSku()`

View source (opens new window)

Arguments

$sku (?string)

Returns

void

# Protected Methods

Method	Description
defineBehaviors() (opens new window)	Returns the behaviors to attach to this class.
defineRules()
extractFieldsFor() (opens new window)	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window)	Extracts the root field names from nested fields.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

# `defineRules()`

View source (opens new window)

# Constants

Constant	Description
`SCENARIO_DEFAULT`	The name of the default scenario.

← Email LineItemStatus →

LineItem

# Public Properties

# adjustments

# adjustmentsTotal

# adjustmentsTotalAsCurrency

# dateCreated

# dateUpdated

# description

# discount

# discountAsCurrency

# height

# id

# isShippable

# isTaxable

# length

# lineItemStatus

# lineItemStatusId

# note

# onSale

# options

# optionsSignature

# order

# orderId

# price

# priceAsCurrency

# privateNote

# purchasable

# purchasableId

# qty

# saleAmount

# saleAmountAsCurrency

# salePrice

# salePriceAsCurrency

# shippingCategory

# shippingCategoryId

# shippingCost

# shippingCostAsCurrency

# sku

# snapshot

# subtotal

# subtotalAsCurrency

# tax

# taxAsCurrency

# taxCategory

# taxCategoryId

# taxIncluded

# taxIncludedAsCurrency

# total

# totalAsCurrency

# uid

# weight

# width

# Public Methods

# attributes()

Returns

# behaviors()

Returns

# currencyAttributes()

# extraFields()

Returns

# fields()

Returns

# getAdjustments()

Returns

Throws

# getAdjustmentsTotal()

Arguments

Throws

# getDescription()

Returns

# getDiscount()

Throws

# getIsShippable()

# getIsTaxable()

# getLineItemStatus()

Throws

# getOnSale()

# getOptions()

# getOptionsSignature()

# getOrder()

# `adjustments`

# `adjustmentsTotal`

# `adjustmentsTotalAsCurrency`

# `dateCreated`

# `dateUpdated`

# `description`

# `discount`

# `discountAsCurrency`

# `height`

# `id`

# `isShippable`

# `isTaxable`

# `length`

# `lineItemStatus`

# `lineItemStatusId`

# `note`

# `onSale`

# `options`

# `optionsSignature`

# `order`

# `orderId`

# `price`

# `priceAsCurrency`

# `privateNote`

# `purchasable`

# `purchasableId`

# `qty`

# `saleAmount`

# `saleAmountAsCurrency`

# `salePrice`

# `salePriceAsCurrency`

# `shippingCategory`

# `shippingCategoryId`

# `shippingCost`

# `shippingCostAsCurrency`

# `sku`

# `snapshot`

# `subtotal`

# `subtotalAsCurrency`

# `tax`

# `taxAsCurrency`

# `taxCategory`

# `taxCategoryId`

# `taxIncluded`

# `taxIncludedAsCurrency`

# `total`

# `totalAsCurrency`

# `uid`

# `weight`

# `width`

# `attributes()`

# `behaviors()`

# `currencyAttributes()`

# `extraFields()`

# `fields()`

# `getAdjustments()`

# `getAdjustmentsTotal()`

# `getDescription()`

# `getDiscount()`

# `getIsShippable()`

# `getIsTaxable()`

# `getLineItemStatus()`

# `getOnSale()`

# `getOptions()`

# `getOptionsSignature()`

# `getOrder()`

# `getPrice()`

# `getPurchasable()`

# `getSaleAmount()`

# `getSalePrice()`

# `getShippingCategory()`

# `getShippingCost()`

# `getSku()`

# `getSubtotal()`

# `getTax()`

# `getTaxCategory()`

# `getTaxIncluded()`

# `getTaxableSubtotal()`

# `getTotal()`

# `init()`