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

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$addressByIdcraft\commerce\models\Address, null
$addressescraft\commerce\models\Address[]
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$emailstring
$errorsarray – Errors for all attributes or the specified attribute.
$firstErrorsarray – The first errors.
$idinteger – Customer ID
$iteratorArrayIterator – An iterator for traversing the items in the list.
$orderscraft\commerce\elements\Order[]
$primaryBillingAddresscraft\commerce\models\Address, null
$primaryBillingAddressIdinteger – The primary billing address id
$primaryShippingAddresscraft\commerce\models\Address, null
$primaryShippingAddressIdinteger – The primary shipping address id
$scenariostring – The scenario that this model is in.
$subscriptions\craft\commerce\elements\Subscription[]
$usercraft\elements\User, null
$userIdinteger – The user ID
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$addressById

Signature

public craft\commerce\models\Address, null getAddressById ( \craft\commerce\models\int $id = null )

$addresses

Signature

public craft\commerce\models\Address[] getAddresses ( )

$email

Type
string
Access
Read-only

View source

Signature

public string getEmail ( )

$id

Type
integer

Customer ID

View source

Signature

public integer $id = null

$orders

Signature

public craft\commerce\elements\Order[] getOrders ( )

$primaryBillingAddress

Signature

public craft\commerce\models\Address, null getPrimaryBillingAddress ( )

$primaryBillingAddressId

Type
integer

The primary billing address id

View source

Signature

public integer $primaryBillingAddressId = null

$primaryShippingAddress

Signature

public craft\commerce\models\Address, null getPrimaryShippingAddress ( )

$primaryShippingAddressId

Type
integer

The primary shipping address id

View source

Signature

public integer $primaryShippingAddressId = null

$subscriptions

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

View source

Signature

public \craft\commerce\elements\Subscription[] getSubscriptions ( )

$user

Signature

public craft\elements\User, null getUser ( )
public void setUser ( craft\elements\User $user )

$userId

Type
integer

The user ID

View source

Signature

public integer $userId = null

Public Methods

MethodDescription
__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.
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.
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

Signature

public string __toString ( )

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

Signature

public craft\commerce\models\Address, null getAddressById ( \craft\commerce\models\int $id = null )

getAddresses()

Returns the addresses associated with this customer.

View source

Returns

craft\commerce\models\Address[]

Signature

public craft\commerce\models\Address[] getAddresses ( )

getEmail()

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

View source

Returns

string

Signature

public string getEmail ( )

getOrders()

Returns the order elements associated with this customer.

View source

Returns

craft\commerce\elements\Order[]

Signature

public craft\commerce\elements\Order[] getOrders ( )

getPrimaryBillingAddress()

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

View source

Returns

craft\commerce\models\Address, null

Signature

public craft\commerce\models\Address, null getPrimaryBillingAddress ( )

getPrimaryShippingAddress()

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

View source

Returns

craft\commerce\models\Address, null

Signature

public craft\commerce\models\Address, null getPrimaryShippingAddress ( )

getSubscriptions()

Returns the subscription elements associated with this customer.

View source

Returns

\craft\commerce\elements\Subscription[]

Signature

public \craft\commerce\elements\Subscription[] getSubscriptions ( )

getUser()

Returns the user element associated with this customer.

View source

Returns

craft\elements\User, null

Throws

Signature

public craft\elements\User, null getUser ( )

setUser()

Sets the user this customer is related to.

View source

Arguments

Signature

public void setUser ( craft\elements\User $user )

Protected Methods

MethodDescription
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

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.