Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
CustomerInterface Interface Reference
Inheritance diagram for CustomerInterface:
CustomAttributesDataInterface ExtensibleDataInterface Customer

Public Member Functions

 getId ()
 
 setId ($id)
 
 getGroupId ()
 
 setGroupId ($groupId)
 
 getDefaultBilling ()
 
 setDefaultBilling ($defaultBilling)
 
 getDefaultShipping ()
 
 setDefaultShipping ($defaultShipping)
 
 getConfirmation ()
 
 setConfirmation ($confirmation)
 
 getCreatedAt ()
 
 setCreatedAt ($createdAt)
 
 getUpdatedAt ()
 
 setUpdatedAt ($updatedAt)
 
 getCreatedIn ()
 
 setCreatedIn ($createdIn)
 
 getDob ()
 
 setDob ($dob)
 
 getEmail ()
 
 setEmail ($email)
 
 getFirstname ()
 
 setFirstname ($firstname)
 
 getLastname ()
 
 setLastname ($lastname)
 
 getMiddlename ()
 
 setMiddlename ($middlename)
 
 getPrefix ()
 
 setPrefix ($prefix)
 
 getSuffix ()
 
 setSuffix ($suffix)
 
 getGender ()
 
 setGender ($gender)
 
 getStoreId ()
 
 setStoreId ($storeId)
 
 getTaxvat ()
 
 setTaxvat ($taxvat)
 
 getWebsiteId ()
 
 setWebsiteId ($websiteId)
 
 getAddresses ()
 
 setAddresses (array $addresses=null)
 
 getDisableAutoGroupChange ()
 
 setDisableAutoGroupChange ($disableAutoGroupChange)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\Customer\Api\Data\CustomerExtensionInterface $extensionAttributes)
 
- Public Member Functions inherited from CustomAttributesDataInterface
 getCustomAttribute ($attributeCode)
 
 setCustomAttribute ($attributeCode, $attributeValue)
 
 getCustomAttributes ()
 
 setCustomAttributes (array $attributes)
 

Data Fields

const ID = 'id'
 
const CONFIRMATION = 'confirmation'
 
const CREATED_AT = 'created_at'
 
const UPDATED_AT = 'updated_at'
 
const CREATED_IN = 'created_in'
 
const DOB = 'dob'
 
const EMAIL = 'email'
 
const FIRSTNAME = 'firstname'
 
const GENDER = 'gender'
 
const GROUP_ID = 'group_id'
 
const LASTNAME = 'lastname'
 
const MIDDLENAME = 'middlename'
 
const PREFIX = 'prefix'
 
const STORE_ID = 'store_id'
 
const SUFFIX = 'suffix'
 
const TAXVAT = 'taxvat'
 
const WEBSITE_ID = 'website_id'
 
const DEFAULT_BILLING = 'default_billing'
 
const DEFAULT_SHIPPING = 'default_shipping'
 
const KEY_ADDRESSES = 'addresses'
 
const DISABLE_AUTO_GROUP_CHANGE = 'disable_auto_group_change'
 
- Data Fields inherited from CustomAttributesDataInterface
const CUSTOM_ATTRIBUTES = 'custom_attributes'
 
- Data Fields inherited from ExtensibleDataInterface
const EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
 

Detailed Description

Customer interface. @api

Since
100.0.2

Definition at line 13 of file CustomerInterface.php.

Member Function Documentation

◆ getAddresses()

getAddresses ( )

Get customer addresses.

Returns
\Magento\Customer\Api\Data\AddressInterface[]|null

Implemented in Customer.

◆ getConfirmation()

getConfirmation ( )

Get confirmation

Returns
string|null

Implemented in Customer.

◆ getCreatedAt()

getCreatedAt ( )

Get created at time

Returns
string|null

Implemented in Customer.

◆ getCreatedIn()

getCreatedIn ( )

Get created in area

Returns
string|null

Implemented in Customer.

◆ getDefaultBilling()

getDefaultBilling ( )

Get default billing address id

Returns
string|null

Implemented in Customer.

◆ getDefaultShipping()

getDefaultShipping ( )

Get default shipping address id

Returns
string|null

Implemented in Customer.

◆ getDisableAutoGroupChange()

getDisableAutoGroupChange ( )

Get disable auto group change flag.

Returns
int|null

Implemented in Customer.

◆ getDob()

getDob ( )

Get date of birth

Returns
string|null

Implemented in Customer.

◆ getEmail()

getEmail ( )

Get email address

Returns
string

Implemented in Customer.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns
\Magento\Customer\Api\Data\CustomerExtensionInterface|null

Implemented in Customer.

◆ getFirstname()

getFirstname ( )

Get first name

Returns
string

Implemented in Customer.

◆ getGender()

getGender ( )

Get gender

Returns
int|null

Implemented in Customer.

◆ getGroupId()

getGroupId ( )

Get group id

Returns
int|null

Implemented in Customer.

◆ getId()

getId ( )

#- Get customer id

Returns
int|null

Implemented in Customer.

◆ getLastname()

getLastname ( )

Get last name

Returns
string

Implemented in Customer.

◆ getMiddlename()

getMiddlename ( )

Get middle name

Returns
string|null

Implemented in Customer.

◆ getPrefix()

getPrefix ( )

Get prefix

Returns
string|null

Implemented in Customer.

◆ getStoreId()

getStoreId ( )

Get store id

Returns
int|null

Implemented in Customer.

◆ getSuffix()

getSuffix ( )

Get suffix

Returns
string|null

Implemented in Customer.

◆ getTaxvat()

getTaxvat ( )

Get tax Vat

Returns
string|null

Implemented in Customer.

◆ getUpdatedAt()

getUpdatedAt ( )

Get updated at time

Returns
string|null

Implemented in Customer.

◆ getWebsiteId()

getWebsiteId ( )

Get website id

Returns
int|null

Implemented in Customer.

◆ setAddresses()

setAddresses ( array  $addresses = null)

Set customer addresses.

Parameters

Implemented in Customer.

◆ setConfirmation()

setConfirmation (   $confirmation)

Set confirmation

Parameters
string$confirmation
Returns
$this

Implemented in Customer.

◆ setCreatedAt()

setCreatedAt (   $createdAt)

Set created at time

Parameters
string$createdAt
Returns
$this

Implemented in Customer.

◆ setCreatedIn()

setCreatedIn (   $createdIn)

Set created in area

Parameters
string$createdIn
Returns
$this

Implemented in Customer.

◆ setDefaultBilling()

setDefaultBilling (   $defaultBilling)

Set default billing address id

Parameters
string$defaultBilling
Returns
$this

Implemented in Customer.

◆ setDefaultShipping()

setDefaultShipping (   $defaultShipping)

Set default shipping address id

Parameters
string$defaultShipping
Returns
$this

Implemented in Customer.

◆ setDisableAutoGroupChange()

setDisableAutoGroupChange (   $disableAutoGroupChange)

Set disable auto group change flag.

Parameters
int$disableAutoGroupChange
Returns
$this

Implemented in Customer.

◆ setDob()

setDob (   $dob)

Set date of birth

Parameters
string$dob
Returns
$this

Implemented in Customer.

◆ setEmail()

setEmail (   $email)

Set email address

Parameters
string$email
Returns
$this

Implemented in Customer.

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Customer\Api\Data\CustomerExtensionInterface  $extensionAttributes)

Set an extension attributes object.

Parameters
\Magento\Customer\Api\Data\CustomerExtensionInterface$extensionAttributes
Returns
$this

◆ setFirstname()

setFirstname (   $firstname)

Set first name

Parameters
string$firstname
Returns
$this

Implemented in Customer.

◆ setGender()

setGender (   $gender)

Set gender

Parameters
int$gender
Returns
$this

Implemented in Customer.

◆ setGroupId()

setGroupId (   $groupId)

Set group id

Parameters
int$groupId
Returns
$this

Implemented in Customer.

◆ setId()

setId (   $id)

Set customer id

Parameters
int$id
Returns
$this

Implemented in Customer.

◆ setLastname()

setLastname (   $lastname)

Set last name

Parameters
string$lastname
Returns
$this

Implemented in Customer.

◆ setMiddlename()

setMiddlename (   $middlename)

Set middle name

Parameters
string$middlename
Returns
$this

Implemented in Customer.

◆ setPrefix()

setPrefix (   $prefix)

Set prefix

Parameters
string$prefix
Returns
$this

Implemented in Customer.

◆ setStoreId()

setStoreId (   $storeId)

Set store id

Parameters
int$storeId
Returns
$this

Implemented in Customer.

◆ setSuffix()

setSuffix (   $suffix)

Set suffix

Parameters
string$suffix
Returns
$this

Implemented in Customer.

◆ setTaxvat()

setTaxvat (   $taxvat)

Set tax Vat

Parameters
string$taxvat
Returns
$this

Implemented in Customer.

◆ setUpdatedAt()

setUpdatedAt (   $updatedAt)

Set updated at time

Parameters
string$updatedAt
Returns
$this

Implemented in Customer.

◆ setWebsiteId()

setWebsiteId (   $websiteId)

Set website id

Parameters
int$websiteId
Returns
$this

Implemented in Customer.

Field Documentation

◆ CONFIRMATION

const CONFIRMATION = 'confirmation'

Definition at line 19 of file CustomerInterface.php.

◆ CREATED_AT

const CREATED_AT = 'created_at'

Definition at line 20 of file CustomerInterface.php.

◆ CREATED_IN

const CREATED_IN = 'created_in'

Definition at line 22 of file CustomerInterface.php.

◆ DEFAULT_BILLING

const DEFAULT_BILLING = 'default_billing'

Definition at line 35 of file CustomerInterface.php.

◆ DEFAULT_SHIPPING

const DEFAULT_SHIPPING = 'default_shipping'

Definition at line 36 of file CustomerInterface.php.

◆ DISABLE_AUTO_GROUP_CHANGE

const DISABLE_AUTO_GROUP_CHANGE = 'disable_auto_group_change'

Definition at line 38 of file CustomerInterface.php.

◆ DOB

const DOB = 'dob'

Definition at line 23 of file CustomerInterface.php.

◆ EMAIL

const EMAIL = 'email'

Definition at line 24 of file CustomerInterface.php.

◆ FIRSTNAME

const FIRSTNAME = 'firstname'

Definition at line 25 of file CustomerInterface.php.

◆ GENDER

const GENDER = 'gender'

Definition at line 26 of file CustomerInterface.php.

◆ GROUP_ID

const GROUP_ID = 'group_id'

Definition at line 27 of file CustomerInterface.php.

◆ ID

const ID = 'id'

#+ Constants defined for keys of the data array. Identical to the name of the getter in snake case

Definition at line 18 of file CustomerInterface.php.

◆ KEY_ADDRESSES

const KEY_ADDRESSES = 'addresses'

Definition at line 37 of file CustomerInterface.php.

◆ LASTNAME

const LASTNAME = 'lastname'

Definition at line 28 of file CustomerInterface.php.

◆ MIDDLENAME

const MIDDLENAME = 'middlename'

Definition at line 29 of file CustomerInterface.php.

◆ PREFIX

const PREFIX = 'prefix'

Definition at line 30 of file CustomerInterface.php.

◆ STORE_ID

const STORE_ID = 'store_id'

Definition at line 31 of file CustomerInterface.php.

◆ SUFFIX

const SUFFIX = 'suffix'

Definition at line 32 of file CustomerInterface.php.

◆ TAXVAT

const TAXVAT = 'taxvat'

Definition at line 33 of file CustomerInterface.php.

◆ UPDATED_AT

const UPDATED_AT = 'updated_at'

Definition at line 21 of file CustomerInterface.php.

◆ WEBSITE_ID

const WEBSITE_ID = 'website_id'

Definition at line 34 of file CustomerInterface.php.


The documentation for this interface was generated from the following file: