OrderAdjustment

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\OrderAdjustment » 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

Order adjustment model.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
amount	float – Amount
amountAsCurrency	string
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
currency	string
description	string, null – Description
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
id	integer, null – ID
included	boolean – Included
isEstimated	boolean – Whether the adjustment is based of estimated data
iterator	ArrayIterator – An iterator for traversing the items in the list.
lineItem	craft\commerce\models\LineItem, null
lineItemId	integer, null – Line item ID this adjustment belongs to
name	string – Name
order	craft\commerce\elements\Order, null
orderId	integer, null – Order ID
scenario	string – The scenario that this model is in.
sourceSnapshot	array
type	string – Type
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

amount

Type

float

Default value

null

Amount

View source

amountAsCurrency

Type

string

Default value

null

View source

currency

Type

string

Default value

null

View source

description

Type

string, null

Default value

null

Description

View source

id

Type

integer, null

Default value

null

ID

View source

included

Type

boolean

Default value

false

Included

View source

isEstimated

Type

boolean

Default value

false

Whether the adjustment is based of estimated data

View source

lineItem

Type

craft\commerce\models\LineItem, null

Default value

null

View source

lineItemId

Type

integer, null

Default value

null

Line item ID this adjustment belongs to

View source

name

Type

string

Default value

null

Name

View source

order

Type

craft\commerce\elements\Order, null

Default value

null

View source

orderId

Type

integer, null

Default value

null

Order ID

View source

sourceSnapshot

Type

array

Default value

null

View source

type

Type

string

Default value

null

Type

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()
__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()
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.
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.
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.
getLineItem()
getOrder()
getScenario()	Returns the scenario that this model is used in.
getSourceSnapshot()	Gets the options for the line item.
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.
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.
setLineItem()
setOrder()
setScenario()	Sets the scenario for the model.
setSourceSnapshot()	Set the options 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()

View source

currencyAttributes()

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

View source

getLineItem()

View source

Throws

• yii\base\InvalidConfigException

getOrder()

View source

Throws

• yii\base\InvalidConfigException

getSourceSnapshot()

Gets the options for the line item.

View source

setLineItem()

View source

Arguments

• $lineItem

setOrder()

View source

Arguments

• $order

setSourceSnapshot()

Set the options array on the line item.

View source

Arguments

• $snapshot

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
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.
getCurrency()
resolveFields()	Determines which fields can be returned by toArray().

defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

getCurrency()

View source

Returns

?string

Throws

• yii\base\InvalidConfigException

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.