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

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
adjustments craft\commerce\models\OrderAdjustment[]
adjustmentsTotal float
attributes array – Attribute values (name => value).
behaviors yii\base\Behavior – List of behaviors attached to this component
dateCreated DateTime, null
description string
discount float
errors array – Errors for all attributes or the specified attribute.
firstErrors array – The first errors.
height float – Height
id integer, null – ID
iterator ArrayIterator – An iterator for traversing the items in the list.
length float – Length
lineItemStatus craft\commerce\models\LineItemStatus, null
lineItemStatusId integer – Line Item Status ID
note string – Note
onSale boolean
options array
optionsSignature
order craft\commerce\elements\Order, null
orderId integer – Order ID
price float
privateNote string – Private Note
purchasable craft\commerce\base\PurchasableInterface, null
purchasableId integer – Purchasable ID
qty integer – Quantity
saleAmount float
salePrice float – Sale Price
scenario string – The scenario that this model is in.
shippingCategory craft\commerce\models\ShippingCategory
shippingCategoryId integer – Shipping category ID
shippingCost float
sku string
snapshot mixed – Snapshot
subtotal float
tax float
taxCategory craft\commerce\models\TaxCategory
taxCategoryId integer – Tax category ID
taxIncluded float
total float
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.
weight float – Weight
width float – Width

# adjustments

Type
craft\commerce\models\OrderAdjustment[]
Access
Read-only

View source

# adjustmentsTotal

Type
float
Access
Read-only

View source

# dateCreated

Type
DateTime, null
Since
2.2

View source

# description

Type
string

View source

# discount

Type
float
Access
Read-only

View source

# height

Type
float

Height

View source

# id

Type
integer, null

ID

View source

# length

Type
float

Length

View source

# lineItemStatus

Type
craft\commerce\models\LineItemStatus, null
Access
Read-only

View source

# lineItemStatusId

Type
integer

Line Item Status ID

View source

# note

Type
string

Note

View source

# onSale

Type
boolean
Access
Read-only

View source

# options

Type
array

View source

# optionsSignature

Access
Read-only

View source

# order

Type
craft\commerce\elements\Order, null

View source

# orderId

Type
integer

Order ID

View source

# price

Type
float
Since
3.1.1

View source

# privateNote

Type
string

Private Note

View source

# purchasable

Type
craft\commerce\base\PurchasableInterface, null

View source

# purchasableId

Type
integer

Purchasable ID

View source

# qty

Type
integer

Quantity

View source

# saleAmount

Type
float
Since
3.1.1

View source

# salePrice

Type
float

Sale Price

View source

# shippingCategory

Type
craft\commerce\models\ShippingCategory
Access
Read-only

View source

# shippingCategoryId

Type
integer

Shipping category ID

View source

# shippingCost

Type
float
Access
Read-only

View source

# sku

Type
string

View source

# snapshot

Type
mixed

Snapshot

View source

# subtotal

Type
float
Access
Read-only

View source

# tax

Type
float
Access
Read-only

View source

# taxCategory

Type
craft\commerce\models\TaxCategory
Access
Read-only

View source

# taxCategoryId

Type
integer

Tax category ID

View source

# taxIncluded

Type
float
Access
Read-only

View source

# total

Type
float
Access
Read-only

View source

# weight

Type
float

Weight

View source

# width

Type
float

Width

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__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.
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.
defineRules()
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()
getAdjustmentsTotalByType()
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()
getError() Returns the first error of the specified attribute.
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.
getIterator() 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() 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() 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.
populateFromPurchasable()
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()
setOptions() Set the options array on the line item.
setOrder()
setPrice()
setPurchasable()
setSaleAmount()
setSalePrice()
setScenario() Sets the scenario for the model.
setSku()
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

array – 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() 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

Returns

array

# defineRules()

View source

Returns

array

# 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:

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 ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on scenario or 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 attributes() indexed by the same attribute names.

View source

Returns

array – The list of field names or field definitions.

# getAdjustments()

View source

Returns

craft\commerce\models\OrderAdjustment[]

# getAdjustmentsTotal()

View source

Arguments

Returns

float

# getAdjustmentsTotalByType()

DEPRECATED

Deprecated in 2.2

View source

Arguments

Returns

float, integer

# getDescription()

View source

Returns

string

# getDiscount()

View source

Returns

float

# getLineItemStatus()

View source

Returns

craft\commerce\models\LineItemStatus, null

# getOnSale()

View source

Returns

boolean

# getOptions()

Returns the options for the line item.

View source

Returns

array

# getOptionsSignature()

Returns a unique hash of the line item options

View source

# getOrder()

View source

Returns

craft\commerce\elements\Order, null

# getPrice()

Since
3.1.1

View source

Returns

float

# getPurchasable()

View source

Returns

craft\commerce\base\PurchasableInterface, null

# getSaleAmount()

Since
3.1.1

View source

Returns

float

# getSalePrice()

View source

Returns

float – Sale Price

# getShippingCategory()

View source

Returns

craft\commerce\models\ShippingCategory

Throws

# getShippingCost()

View source

Returns

float

# getSku()

View source

Returns

string

# getSubtotal()

View source

Returns

float

# getTax()

View source

Returns

float

# getTaxCategory()

View source

Returns

craft\commerce\models\TaxCategory

Throws

# getTaxIncluded()

View source

Returns

float

# getTaxableSubtotal()

View source

Arguments

  • $taxable

Returns

float, integer

# getTotal()

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

View source

Returns

float

# 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

# populateFromPurchasable()

View source

Arguments

# refreshFromPurchasable()

View source

Returns

boolean – False when no related purchasable exists

# setDescription()

View source

Arguments

  • $description

# setOptions()

Set the options array on the line item.

View source

Arguments

# setOrder()

View source

Arguments

# setPrice()

Since
3.1.1

View source

Arguments

  • $price

# setPurchasable()

View source

Arguments

# setSaleAmount()

DEPRECATED

Deprecated in 3.1.1

Since
3.1.1

View source

Arguments

  • $saleAmount

Throws

# setSalePrice()

Since
3.1.1

View source

Arguments

  • $salePrice

# setSku()

View source

Arguments

  • $sku

# Protected Methods

Method Description
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().

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.