OrderStatus

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\OrderStatus » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, craft\commerce\base\HasStoreInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\commerce\base\StoreTrait, craft\db\SoftDeleteTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

2.0

Order status model.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
color	string – Color
config
cpEditUrl	string
dateDeleted	DateTime, null – Date deleted
default	boolean – Default status
description	string, null – Description
displayName	string
emailIds	array
emails	craft\commerce\models\Email[]
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
handle	string, null – Handle
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
labelHtml	string
name	string, null – Name
scenario	string – The scenario that this model is in.
sortOrder	integer, null – Sort order
store	craft\commerce\models\Store
storeId	integer, null – Store ID
uid	string, null – UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

color

Type

string

Default value

'green'

Color

View source

config

Default value

null

Access

Read-only

Since

5.0.3

View source

cpEditUrl

Type

string

Default value

null

View source

dateDeleted

Type

DateTime, null

Default value

null

Date deleted

View source

default

Type

boolean

Default value

false

Default status

View source

description

Type

string, null

Default value

null

Description

View source

displayName

Type

string

Default value

null

View source

emailIds

Type

array

Default value

null

View source

emails

Type

craft\commerce\models\Email[]

Default value

null

View source

handle

Type

string, null

Default value

null

Handle

View source

id

Type

integer, null

Default value

null

ID

View source

labelHtml

Type

string

Default value

null

View source

name

Type

string, null

Default value

null

Name

View source

sortOrder

Type

integer, null

Default value

null

Sort order

View source

uid

Type

string, null

Default value

null

UID

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.
__toString()
__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.
beforeRestore()	This method is called at the beginning of restoring a record.
beforeValidate()	This method is invoked before validation starts.
behaviors()
canDelete()
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().
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.
find()
findTrashed()
findWithTrashed()
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.
getConfig()	Returns the config for this status.
getCpEditUrl()
getDisplayName()
getEmailIds()
getEmails()
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.
getLabelHtml()
getScenario()	Returns the scenario that this model is used in.
getStore()
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.
setScenario()	Sets the scenario for the model.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

__toString()

View source

Returns

string

behaviors()

View source

canDelete()

Since

2.2

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.

getConfig()

Since

5.0.3

Returns the config for this status.

View source

Arguments

• $emailIds

getCpEditUrl()

View source

getDisplayName()

Since

2.2

View source

getEmailIds()

View source

Throws

• yii\base\InvalidConfigException

getEmails()

View source

Returns

craft\commerce\models\Email[]

Throws

• yii\base\InvalidConfigException

getLabelHtml()

View source

Protected Methods

Method	Description
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

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.