OrderAdjustment

Type
Class
Namespace
craft\commerce\models
Inherits
craft\commerce\models\OrderAdjustment » 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

Order adjustment model.

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).
amount float (opens new window) – Amount
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
description string (opens new window) – Description
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.
id integer (opens new window) – ID
included boolean (opens new window) – Included
isEstimated boolean (opens new window) – Whether the adjustment is based of estimated data
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
lineItem craft\commerce\models\LineItem, null (opens new window)
lineItemId integer (opens new window) – Line item ID this adjustment belongs to
name string (opens new window) – Name
order craft\commerce\elements\Order, null (opens new window)
orderId integer (opens new window) – Order ID
scenario (opens new window) string (opens new window) – The scenario that this model is in.
sourceSnapshot
type string (opens new window) – Type
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# amount

Type
float (opens new window)
Default value
null

Amount

View source (opens new window)

# description

Type
string (opens new window)
Default value
null

Description

View source (opens new window)

# id

Type
integer (opens new window)
Default value
null

ID

View source (opens new window)

# included

Type
boolean (opens new window)
Default value
false

Included

View source (opens new window)

# isEstimated

Type
boolean (opens new window)
Default value
false

Whether the adjustment is based of estimated data

View source (opens new window)

# lineItem

Type
craft\commerce\models\LineItem, null (opens new window)
Default value
null

View source (opens new window)

# lineItemId

Type
integer (opens new window)
Default value
null

Line item ID this adjustment belongs to

View source (opens new window)

# name

Type
string (opens new window)
Default value
null

Name

View source (opens new window)

# order

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

View source (opens new window)

# orderId

Type
integer (opens new window)
Default value
null

Order ID

View source (opens new window)

# sourceSnapshot

Default value
null

View source (opens new window)

# type

Type
string (opens new window)
Default value
null

Type

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 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()
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.
defineRules() Returns the validation rules for attributes.
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() (opens new window) 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.
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).
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.
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.
getLineItem()
getOrder()
getScenario() (opens new window) Returns the scenario that this model is used in.
getSourceSnapshot() Gets the options for the line item.
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() (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.
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.
setLineItem()
setOrder()
setScenario() (opens new window) Sets the scenario for the model.
setSourceSnapshot() Set the options array on the line item.
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.

# behaviors()

View source (opens new window)

# currencyAttributes()

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

View source (opens new window)

Returns

array (opens new window)

# defineRules()

Returns the validation rules for attributes.

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

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

View source (opens new window)

Returns

array (opens new window)

# getLineItem()

View source (opens new window)

Returns

craft\commerce\models\LineItem, null (opens new window)

# getOrder()

View source (opens new window)

Returns

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

# getSourceSnapshot()

Gets the options for the line item.

View source (opens new window)

# setLineItem()

View source (opens new window)

Arguments

Returns

void

# setOrder()

View source (opens new window)

Arguments

Returns

void

# setSourceSnapshot()

Set the options array on the line item.

View source (opens new window)

Arguments

# Protected Methods

Method Description
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.
getCurrency()
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).

# getCurrency()

View source (opens new window)

Returns

string (opens new window)

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.