Craft Commerce 5 Class Reference

Appearance

LineItem ​

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

Line Item model representing a line item on an order.

View source

Public Properties ​

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
adjustmentsarray, craft\commerce\models\OrderAdjustment[]
adjustmentsTotal
adjustmentsTotalAsCurrencystring
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
dateCreatedDateTime, null
dateUpdatedDateTime, null
descriptionstring
discountfloat
discountAsCurrencystring
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
fulfilledTotalQuantityinteger
hasFreeShippingboolean
heightfloat – Height
idinteger, null – ID
isPromotableboolean
isShippableboolean
isTaxableboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
lengthfloat – Length
lineItemStatuscraft\commerce\models\LineItemStatus, null
lineItemStatusIdinteger, null – Line Item Status ID
notestring – Note
onPromotionboolean
onSaleboolean
optionsarray
optionsSignaturestring – the unique hash of the options
ordercraft\commerce\elements\Order
orderIdinteger, null – Order ID
pricefloat
priceAsCurrencystring
privateNotestring – Private Note
promotionalAmountfloat
promotionalPricefloat, integer
purchasablecraft\commerce\base\Purchasable
purchasableIdinteger, null – Purchasable ID
qtyinteger – Quantity
saleAmountfloat
saleAmountAsCurrencystring
salePricefloat
salePriceAsCurrencystring
scenariostring – The scenario that this model is in.
shippingCategorycraft\commerce\models\ShippingCategory
shippingCategoryIdinteger, null – Shipping category ID
shippingCostinteger
shippingCostAsCurrencystring
skustring
snapshotarray
subtotalfloat – the Purchasable’s sale price multiplied by the quantity of the line item
subtotalAsCurrencystring
taxinteger
taxAsCurrencystring
taxCategorycraft\commerce\models\TaxCategory
taxCategoryIdinteger, null – Tax category ID
taxIncludedinteger
taxIncludedAsCurrencystring
totalfloat – the subTotal plus any adjustments belonging to this line item
totalAsCurrencystring
type\craft\commerce\enums\LineItemType
uidstring, null – UID
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
weightfloat – Weight
widthfloat – Width

adjustments ​

Type
array, craft\commerce\models\OrderAdjustment[]
Default value
null

View source

adjustmentsTotal ​

Default value
null
Access
Read-only

View source

adjustmentsTotalAsCurrency ​

Type
string
Default value
null

View source

dateCreated ​

Type
DateTime, null
Default value
null
Since
2.2

View source

dateUpdated ​

Type
DateTime, null
Default value
null
Since
3.2.0

View source

description ​

Type
string
Default value
null

View source

discount ​

Type
float
Default value
null

View source

discountAsCurrency ​

Type
string
Default value
null

View source

fulfilledTotalQuantity ​

Type
integer
Default value
null
Access
Read-only
Since
5.0.0

View source

hasFreeShipping ​

Type
boolean
Default value
null

View source

height ​

Type
float
Default value
0

Height

View source

id ​

Type
integer, null
Default value
null

ID

View source

isPromotable ​

Type
boolean
Default value
null

View source

isShippable ​

Type
boolean
Default value
null

View source

isTaxable ​

Type
boolean
Default value
null

View source

length ​

Type
float
Default value
0

Length

View source

lineItemStatus ​

Type
craft\commerce\models\LineItemStatus, null
Default value
null

View source

lineItemStatusId ​

Type
integer, null
Default value
null

Line Item Status ID

View source

note ​

Type
string
Default value
''

Note

View source

onPromotion ​

Type
boolean
Default value
null

View source

onSale ​

Type
boolean
Default value
null
Access
Read-only

View source

options ​

Type
array
Default value
null

View source

optionsSignature ​

Type
string
Default value
null

the unique hash of the options

View source

order ​

Type
craft\commerce\elements\Order
Default value
null

View source

orderId ​

Type
integer, null
Default value
null

Order ID

View source

price ​

Type
float
Default value
null

View source

priceAsCurrency ​

Type
string
Default value
null

View source

privateNote ​

Type
string
Default value
''

Private Note

View source

promotionalAmount ​

Type
float
Default value
null

View source

promotionalPrice ​

Type
float, integer
Default value
null

View source

purchasable ​

Type
craft\commerce\base\Purchasable
Default value
null

View source

purchasableId ​

Type
integer, null
Default value
null

Purchasable ID

View source

qty ​

Type
integer
Default value
null

Quantity

View source

saleAmount ​

Type
float
Default value
null
Access
Read-only

View source

saleAmountAsCurrency ​

Type
string
Default value
null

View source

salePrice ​

Type
float
Default value
null

View source

salePriceAsCurrency ​

Type
string
Default value
null

View source

shippingCategory ​

Type
craft\commerce\models\ShippingCategory
Default value
null

View source

shippingCategoryId ​

Type
integer, null
Default value
null

Shipping category ID

View source

shippingCost ​

Type
integer
Default value
null

View source

shippingCostAsCurrency ​

Type
string
Default value
null

View source

sku ​

Type
string
Default value
null

View source

snapshot ​

Type
array
Default value
null

View source

subtotal ​

Type
float
Default value
null

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

View source

subtotalAsCurrency ​

Type
string
Default value
null

View source

tax ​

Type
integer
Default value
null

View source

taxAsCurrency ​

Type
string
Default value
null

View source

taxCategory ​

Type
craft\commerce\models\TaxCategory
Default value
null

View source

taxCategoryId ​

Type
integer, null
Default value
null

Tax category ID

View source

taxIncluded ​

Type
integer
Default value
null

View source

taxIncludedAsCurrency ​

Type
string
Default value
null

View source

total ​

Type
float
Default value
null

the subTotal plus any adjustments belonging to this line item

View source

totalAsCurrency ​

Type
string
Default value
null

View source

type ​

Type
\craft\commerce\enums\LineItemType
Default value
\craft\commerce\enums\LineItemType::Purchasable
Since
5.1.0

View source

uid ​

Type
string, null
Default value
null

UID

View source

weight ​

Type
float
Default value
0

Weight

View source

width ​

Type
float
Default value
0

Width

View source

Public Methods ​

MethodDescription
__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()
__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.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
beforeValidate()This method is invoked before validation starts.
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.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
currencyAttributes()The attributes on the order that should be made available as formatted currency.
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
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.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAdjustments()
getAdjustmentsTotal()
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getDescription()
getDiscount()
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getFulfilledTotalQuantity()
getHasFreeShipping()
getIsPromotable()
getIsShippable()
getIsTaxable()
getIterator()Returns an iterator for traversing the attributes in the model.
getLineItemStatus()
getOnPromotion()
getOnSale()
getOptions()Returns the options for the line item.
getOptionsSignature()Returns a unique hash of the line item options
getOrder()
getPrice()
getPromotionalAmount()
getPromotionalPrice()
getPurchasable()
getSaleAmount()
getSalePrice()
getScenario()Returns the scenario that this model is used in.
getShippingCategory()
getShippingCost()
getSku()
getSnapshot()Returns the snapshot for the line item.
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()Returns all the validators declared in rules().
hasErrors()Returns a value indicating whether there is any validation error.
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.
instance()Returns static class instance, which can be used to obtain meta information.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
populate()
populateFromPurchasable()
refresh()
refreshFromPurchasable()
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
setAttributes()Sets the attribute values in a massive way.
setDescription()
setHasFreeShipping()
setIsPromotable()
setIsShippable()
setIsTaxable()
setLineItemStatus()
setOptions()Set the options array on the line item.
setOrder()
setPrice()
setPromotionalPrice()
setPurchasable()
setScenario()Sets the scenario for the model.
setSku()
setSnapshot()Set the snapshot array on the line item.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()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

Returns ​

string[] – 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:

php
'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() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

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

View source

Returns ​

array – The behavior configurations.

currencyAttributes() ​

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

View source

extraFields() ​

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

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), 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

Returns ​

array – 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() when no specific fields are specified.

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

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:

php
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.
php
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

Returns ​

array – The list of field names or field definitions.

getAdjustments() ​

View source

Returns ​

craft\commerce\models\OrderAdjustment[]

Throws ​

getAdjustmentsTotal() ​

View source

Arguments ​

  • $included

Throws ​

getDescription() ​

View source

Returns ​

string

getDiscount() ​

View source

Throws ​

getFulfilledTotalQuantity() ​

Since
5.0.0

View source

Returns ​

integer

Throws ​

getHasFreeShipping() ​

Since
5.1.0

View source

Returns ​

boolean

Throws ​

getIsPromotable() ​

Since
5.1.0

View source

Returns ​

boolean

Throws ​

getIsShippable() ​

Since
3.4

View source

getIsTaxable() ​

Since
3.3.4

View source

getLineItemStatus() ​

View source

Throws ​

getOnPromotion() ​

Since
5.0.0

View source

Returns ​

boolean

getOnSale() ​

DEPRECATED

Deprecated in 5.0.0. Use getOnPromotion() instead.

View source

Returns ​

boolean

Throws ​

getOptions() ​

Returns the options for the line item.

View source

getOptionsSignature() ​

Returns a unique hash of the line item options

View source

getOrder() ​

View source

Throws ​

getPrice() ​

Since
3.1.1

View source

getPromotionalAmount() ​

Since
5.0.0

View source

Returns ​

float

getPromotionalPrice() ​

Since
5.0.0

View source

Returns ​

float, null

getPurchasable() ​

View source

Returns ​

craft\commerce\base\PurchasableInterface, null

Throws ​

getSaleAmount() ​

DEPRECATED

Deprecated in 5.0.0. Use getPromotionalAmount() instead.)

View source

Returns ​

float

Throws ​

getSalePrice() ​

View source

Returns ​

float – Sale Price

getShippingCategory() ​

View source

Returns ​

craft\commerce\models\ShippingCategory

Throws ​

getShippingCost() ​

View source

Throws ​

getSku() ​

View source

Returns ​

string

getSnapshot() ​

Since
5.0.0

Returns the snapshot for the line item.

View source

Returns ​

array

getSubtotal() ​

View source

getTax() ​

View source

Throws ​

getTaxCategory() ​

View source

Throws ​

getTaxIncluded() ​

View source

Throws ​

getTaxableSubtotal() ​

View source

Arguments ​

Returns ​

float

Throws ​

getTotal() ​

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

View source

Throws ​

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

populate() ​

Since
5.1.0

View source

Arguments ​

Returns ​

void

Throws ​

populateFromPurchasable() ​

DEPRECATED

Deprecated in 5.0.0. Use populate() instead.

View source

Arguments ​

Returns ​

void

Throws ​

refresh() ​

Since
5.1.0

View source

Returns ​

boolean

Throws ​

refreshFromPurchasable() ​

DEPRECATED

Deprecated in 5.1.0. Use refresh() instead.

View source

Returns ​

boolean – False when no related purchasable exists

Throws ​

setDescription() ​

View source

Arguments ​

  • $description (?string)

Returns ​

void

setHasFreeShipping() ​

Since
5.1.0

View source

Arguments ​

Returns ​

void

setIsPromotable() ​

Since
5.1.0

View source

Arguments ​

Returns ​

void

setIsShippable() ​

Since
5.1.0

View source

Arguments ​

Returns ​

void

setIsTaxable() ​

Since
5.1.0

View source

Arguments ​

Returns ​

void

setLineItemStatus() ​

Since
3.2.2

View source

Arguments ​

setOptions() ​

Set the options array on the line item.

View source

Arguments ​

  • $options

setOrder() ​

View source

Arguments ​

Returns ​

void

setPrice() ​

Since
3.1.1

View source

Arguments ​

  • $price

setPromotionalPrice() ​

Since
5.0.0

View source

Arguments ​

Returns ​

void

setPurchasable() ​

View source

Arguments ​

Returns ​

void

Throws ​

setSku() ​

View source

Arguments ​

  • $sku (?string)

Returns ​

void

setSnapshot() ​

Since
5.0.0

Set the snapshot array on the line item.

View source

Arguments ​

Returns ​

void

Protected Methods ​

MethodDescription
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()
extractFieldsFor()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()Extracts the root field names from nested fields.
resolveFields()Determines which fields can be returned by toArray().

defineRules() ​

View source

Constants ​

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.