Customer

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

Customer model

View source

# Public Properties

Property Description
activeCarts array
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
addressById craft\commerce\models\Address, null
addresses craft\commerce\models\Address[]
attributes array – Attribute values (name => value).
behaviors yii\base\Behavior – List of behaviors attached to this component
email string
errors array – Errors for all attributes or the specified attribute.
firstErrors array – The first errors.
id integer, null – Customer ID
inactiveCarts array
iterator ArrayIterator – An iterator for traversing the items in the list.
orders craft\commerce\elements\Order[]
primaryBillingAddress craft\commerce\models\Address, null
primaryBillingAddressId integer – The primary billing address id
primaryShippingAddress craft\commerce\models\Address, null
primaryShippingAddressId integer – The primary shipping address id
scenario string – The scenario that this model is in.
subscriptions craft\commerce\elements\Subscription[]
user craft\elements\User, null
userId integer – The user ID
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.

# activeCarts

Type
array
Access
Read-only
Since
2.2

View source

# addressById

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

View source

# addresses

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

View source

# email

Type
string
Access
Read-only

View source

# id

Type
integer, null

Customer ID

View source

# inactiveCarts

Type
array
Access
Read-only
Since
2.2

View source

# orders

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

View source

# primaryBillingAddress

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

View source

# primaryBillingAddressId

Type
integer

The primary billing address id

View source

# primaryShippingAddress

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

View source

# primaryShippingAddressId

Type
integer

The primary shipping address id

View source

# subscriptions

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

View source

# user

Type
craft\elements\User, null

View source

# userId

Type
integer

The user ID

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 an object property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets value of an object property.
__toString() Returns the email address of the customer as the string output.
__unset() Sets an object property to 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().
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.
getActiveCarts()
getActiveValidators() Returns the validators applicable to the current scenario.
getAddressById() Returns an address for the customer.
getAddresses() Returns the addresses associated with this customer.
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.
getEmail() Returns the customers email address if it is related to a user.
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.
getInactiveCarts()
getIterator() Returns an iterator for traversing the attributes in the model.
getOrders() Returns the 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() 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() 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.
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.
setUser() Sets the user this customer is related to.
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Performs the data validation.
validateMultiple() Validates multiple models.

# __toString()

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

View source

Returns

string

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

# getActiveCarts()

Since
2.2

View source

Returns

array

Throws

# getAddressById()

Returns an address for the customer.

View source

Arguments

  • $id (integer, null) – The ID of the address to return, if known

Returns

craft\commerce\models\Address, null

# getAddresses()

Returns the addresses associated with this customer.

View source

Returns

craft\commerce\models\Address[]

# getEmail()

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

View source

Returns

string

# getInactiveCarts()

Since
2.2

View source

Returns

array

Throws

# getOrders()

Returns the order elements associated with this customer.

View source

Returns

craft\commerce\elements\Order[]

# getPrimaryBillingAddress()

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

View source

Returns

craft\commerce\models\Address, null

# getPrimaryShippingAddress()

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

View source

Returns

craft\commerce\models\Address, null

# getSubscriptions()

Returns the subscription elements associated with this customer.

View source

Returns

craft\commerce\elements\Subscription[]

# getUser()

Returns the user element associated with this customer.

View source

Returns

craft\elements\User, null

Throws

# setUser()

Sets the user this customer is related to.

View source

Arguments

# Protected Methods

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

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.