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), 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.

View source (opens new window)

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	craft\commerce\models\OrderAdjustment[]
adjustmentsTotal	float (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)
description
discount	float (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
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
length	float (opens new window) – Length
note	string (opens new window) – Note
onSale	boolean (opens new window)
options	array (opens new window)
optionsSignature
order	craft\commerce\elements\Order, null (opens new window)
orderId	integer (opens new window) – Order ID
price	float (opens new window) – Price is the original price of the purchasable
purchasable	craft\commerce\base\PurchasableInterface, null (opens new window)
purchasableId	integer (opens new window) – Purchasable ID
qty	integer (opens new window) – Quantity
saleAmount	float (opens new window) – Sale amount off the price, based on the sales applied to the purchasable.
salePrice	float (opens new window) – Sale price is the price of the line item.
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	float (opens new window)
sku
snapshot	mixed – Snapshot
subtotal	float (opens new window)
tax	float (opens new window)
taxCategory	craft\commerce\models\TaxCategory
taxCategoryId	integer (opens new window) – Tax category ID
taxIncluded	float (opens new window)
total	float (opens new window)
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

craft\commerce\models\OrderAdjustment[]

Access

Read-only

View source (opens new window)

adjustmentsTotal

Type

float (opens new window)

Access

Read-only

View source (opens new window)

dateCreated

Type

DateTime (opens new window), null (opens new window)

Since

2.2

View source (opens new window)

description

Access

Read-only

View source (opens new window)

discount

Type

float (opens new window)

Access

Read-only

View source (opens new window)

height

Type

float (opens new window)

Height

View source (opens new window)

id

Type

integer (opens new window), null (opens new window)

ID

View source (opens new window)

length

Type

float (opens new window)

Length

View source (opens new window)

note

Type

string (opens new window)

Note

View source (opens new window)

onSale

Type

boolean (opens new window)

Access

Read-only

View source (opens new window)

options

Type

array (opens new window)

View source (opens new window)

optionsSignature

Access

Read-only

View source (opens new window)

order

Type

craft\commerce\elements\Order, null (opens new window)

View source (opens new window)

orderId

Type

integer (opens new window)

Order ID

View source (opens new window)

price

Type

float (opens new window)

Price is the original price of the purchasable

View source (opens new window)

purchasable

Type

craft\commerce\base\PurchasableInterface, null (opens new window)

View source (opens new window)

purchasableId

Type

integer (opens new window)

Purchasable ID

View source (opens new window)

qty

Type

integer (opens new window)

Quantity

View source (opens new window)

saleAmount

Type

float (opens new window)

Sale amount off the price, based on the sales applied to the purchasable.

View source (opens new window)

salePrice

Type

float (opens new window)

Sale price is the price of the line item. Sale price is price + saleAmount

View source (opens new window)

shippingCategory

Type

craft\commerce\models\ShippingCategory

Access

Read-only

View source (opens new window)

shippingCategoryId

Type

integer (opens new window)

Shipping category ID

View source (opens new window)

shippingCost

Type

float (opens new window)

Access

Read-only

View source (opens new window)

sku

Access

Read-only

View source (opens new window)

snapshot

Type

mixed

Snapshot

View source (opens new window)

subtotal

Type

float (opens new window)

Access

Read-only

View source (opens new window)

tax

Type

float (opens new window)

Access

Read-only

View source (opens new window)

taxCategory

Type

craft\commerce\models\TaxCategory

Access

Read-only

View source (opens new window)

taxCategoryId

Type

integer (opens new window)

Tax category ID

View source (opens new window)

taxIncluded

Type

float (opens new window)

Access

Read-only

View source (opens new window)

total

Type

float (opens new window)

Access

Read-only

View source (opens new window)

weight

Type

float (opens new window)

Weight

View source (opens new window)

width

Type

float (opens new window)

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)	Constructor.
__get() (opens new window)	Returns the value of an object property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets value of an object property.
__unset() (opens new window)	Sets an object property to 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() (opens new window)	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).
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() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
fillFromPurchasable()
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()
getAdjustmentsTotalByType()
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()	Returns the description from the snapshot of the purchasable
getDiscount()
getError() (opens new window)	Returns the first error of the specified attribute.
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.
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getOnSale()
getOptions()	Returns the options for the line item.
getOptionsSignature()	Returns a unique hash of the line item options
getOrder()
getPurchasable()
getScenario() (opens new window)	Returns the scenario that this model is used in.
getShippingCategory()
getShippingCost()
getSku()	Returns the Sku from the snapshot of the purchasable
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.
init() (opens new window)	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()
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.
setOptions()	Set the options array on the line item.
setOrder()
setPurchasable()
setScenario() (opens new window)	Sets the scenario for the model.
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

array (opens new window) – List of attribute names.

extraFields()

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

This method is similar to fields() (opens new window) 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() (opens new window) on the format of the return value.

fillFromPurchasable()

DEPRECATED

Deprecated in 2.0 Use populateFromPurchasable() instead.

View source (opens new window)

Arguments

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

getAdjustments()

View source (opens new window)

Returns

craft\commerce\models\OrderAdjustment[]

getAdjustmentsTotal()

View source (opens new window)

Arguments

• $included (boolean (opens new window))

Returns

float (opens new window)

getAdjustmentsTotalByType()

DEPRECATED

Deprecated in 2.2

View source (opens new window)

Arguments

• $type (string (opens new window))
• $included (boolean (opens new window))

Returns

float (opens new window), integer (opens new window)

getDescription()

Returns the description from the snapshot of the purchasable

View source (opens new window)

getDiscount()

View source (opens new window)

Returns

float (opens new window)

getOnSale()

View source (opens new window)

Returns

boolean (opens new window)

getOptions()

Returns the options for the line item.

View source (opens new window)

Returns

array (opens new window)

getOptionsSignature()

Returns a unique hash of the line item options

View source (opens new window)

getOrder()

View source (opens new window)

Returns

craft\commerce\elements\Order, null (opens new window)

getPurchasable()

View source (opens new window)

Returns

craft\commerce\base\PurchasableInterface, null (opens new window)

getShippingCategory()

View source (opens new window)

Returns

craft\commerce\models\ShippingCategory

Throws

• yii\base\InvalidConfigException (opens new window)

getShippingCost()

View source (opens new window)

Returns

float (opens new window)

getSku()

Returns the Sku from the snapshot of the purchasable

View source (opens new window)

getSubtotal()

View source (opens new window)

Returns

float (opens new window)

getTax()

View source (opens new window)

Returns

float (opens new window)

getTaxCategory()

View source (opens new window)

Returns

craft\commerce\models\TaxCategory

Throws

• yii\base\InvalidConfigException (opens new window)

getTaxIncluded()

View source (opens new window)

Returns

float (opens new window)

getTaxableSubtotal()

View source (opens new window)

Arguments

• $taxable

Returns

float (opens new window), integer (opens new window)

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)

Returns

float (opens new window)

populateFromPurchasable()

View source (opens new window)

Arguments

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

refreshFromPurchasable()

View source (opens new window)

Returns

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

rules()

View source (opens new window)

Returns

array (opens new window)

setOptions()

Set the options array on the line item.

View source (opens new window)

Arguments

• $options (array (opens new window), string (opens new window))

setOrder()

View source (opens new window)

Arguments

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

setPurchasable()

View source (opens new window)

Arguments

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

Protected Methods

Method	Description
defineRules() (opens new window)	Returns the validation rules for attributes.
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).

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.