Customer

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

Customer model

View source (opens new window)

# Public Properties

Property Description
activeCarts array (opens new window)
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
addressById craft\commerce\models\Address, null (opens new window)
addresses craft\commerce\models\Address[]
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
cpEditUrl string (opens new window)
email string (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.
id integer (opens new window), null (opens new window) – Customer ID
inactiveCarts array (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
orders craft\commerce\elements\Order[]
primaryBillingAddress craft\commerce\models\Address, null (opens new window)
primaryBillingAddressId integer (opens new window) – The primary billing address id
primaryShippingAddress craft\commerce\models\Address, null (opens new window)
primaryShippingAddressId integer (opens new window) – The primary shipping address id
scenario (opens new window) string (opens new window) – The scenario that this model is in.
subscriptions craft\commerce\elements\Subscription[]
user craft\elements\User (opens new window), null (opens new window)
userId integer (opens new window) – The user ID
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# activeCarts

Type
array (opens new window)
Default value
null
Access
Read-only
Since
2.2

View source (opens new window)

# addressById

Type
craft\commerce\models\Address, null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# addresses

Type
craft\commerce\models\Address[]
Default value
null
Access
Read-only

View source (opens new window)

# cpEditUrl

Type
string (opens new window)
Default value
null
Access
Read-only
Since
3.0

View source (opens new window)

# email

Type
string (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# id

Type
integer (opens new window), null (opens new window)
Default value
null

Customer ID

View source (opens new window)

# inactiveCarts

Type
array (opens new window)
Default value
null
Access
Read-only
Since
2.2

View source (opens new window)

# orders

Type
craft\commerce\elements\Order[]
Default value
null
Access
Read-only

View source (opens new window)

# primaryBillingAddress

Type
craft\commerce\models\Address, null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# primaryBillingAddressId

Type
integer (opens new window)
Default value
null

The primary billing address id

View source (opens new window)

# primaryShippingAddress

Type
craft\commerce\models\Address, null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# primaryShippingAddressId

Type
integer (opens new window)
Default value
null

The primary shipping address id

View source (opens new window)

# subscriptions

Type
craft\commerce\elements\Subscription[]
Default value
null
Access
Read-only

View source (opens new window)

# user

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

View source (opens new window)

# userId

Type
integer (opens new window)
Default value
null

The user ID

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.
__toString() Returns the email address of the customer as the string output.
__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() (opens new window) 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.
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.
getActiveCarts()
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAddressById() Returns an address for the customer.
getAddresses() Returns the addresses associated with this customer.
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.
getCpEditUrl()
getEmail() Returns the customers email address if it is related to a user.
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.
getInactiveCarts()
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getOrders() Returns the completed order elements associated with this customer.
getPrimaryBillingAddress() Returns the customer's primary billing address if it exists.
getPrimaryShippingAddress() Returns the customer's primary shipping address if it exists.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSubscriptions() Returns the subscription elements associated with this customer.
getUser() Returns the user element associated with this customer.
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.
setScenario() (opens new window) Sets the scenario for the model.
setUser() Sets the user this customer is related to.
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.

# __toString()

Returns the email address of the customer as the string output.

View source (opens new window)

Returns

string (opens new window)

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

# getActiveCarts()

Since
2.2

View source (opens new window)

Returns

array (opens new window)

Throws

# getAddressById()

Returns an address for the customer.

View source (opens new window)

Arguments

Returns

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

# getAddresses()

Returns the addresses associated with this customer.

View source (opens new window)

Returns

craft\commerce\models\Address[]

# getCpEditUrl()

Since
3.0

View source (opens new window)

Returns

string (opens new window)

# getEmail()

Returns the customers email address if it is related to a user.

View source (opens new window)

Returns

string (opens new window)

# getInactiveCarts()

Since
2.2

View source (opens new window)

Returns

array (opens new window)

Throws

# getOrders()

Returns the completed order elements associated with this customer.

Orders are returned with the most recent first.

View source (opens new window)

Returns

craft\commerce\elements\Order[]

# getPrimaryBillingAddress()

Returns the customer's primary billing address if it exists.

View source (opens new window)

Returns

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

# getPrimaryShippingAddress()

Returns the customer's primary shipping address if it exists.

View source (opens new window)

Returns

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

# getSubscriptions()

Returns the subscription elements associated with this customer.

View source (opens new window)

Returns

craft\commerce\elements\Subscription[]

# getUser()

Returns the user element associated with this customer.

View source (opens new window)

Returns

craft\elements\User (opens new window), null (opens new window)

# setUser()

Sets the user this customer is related to.

View source (opens new window)

Arguments

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