API Documentation
Back to top  

Customer

Implements \CustomerInterface

Class Customer

This class is used for managing customer data

category

System
package

Customer
implements

CustomerInterface

Methods

Constructor of the class Customer

__construct()

Add Addon Values

addAddonValues(\KeyValueCollection $keyValueCollection) : \GXEngineProduct

Adds a key value collection to a product.

Arguments

$keyValueCollection

\KeyValueCollection

The key value collection to add.

Response

\GXEngineProduct

Same instance for chained method calls.

Delete Addon Value

deleteAddonValue(\StringType $key) : \GXEngineProduct

Deletes an addon value of a product.

Throws
\InvalidArgumentException

if the key is not valid.

Arguments

$key

\StringType

The key of the addon value to delete.

Response

\GXEngineProduct

Same instance for chained method calls.

Get Addon Value

getAddonValue(\StringType $key) : string

Returns the addon value of a product, depending on the provided key.

Throws
\InvalidArgumentException

if the key is not valid.

Arguments

$key

\StringType

The key of the addon value to return.

Response

string

The addon value.

Returns the customer ID.

getAddonValueContainerId() : integer

Response

integer

Get Addon Values

getAddonValues() : \KeyValueCollection

Returns a key value collection of the product.

Response

\KeyValueCollection

The key value collection.

Returns the customer's number.

getCustomerNumber() : string

Response

string

customerNumber Customer's number.

Returns the customer's date of birth.

getDateOfBirth() : \DateTime

Response

\DateTime

date of birth Customer's date of birth.

Returns the customer's default address.

getDefaultAddress() : \CustomerAddressInterface

Response

\CustomerAddressInterface

Customer's default address.

Returns the customer's email.

getEmail() : \CustomerEmailInterface

Response

\CustomerEmailInterface

Customer's email.

Returns the customer's fax number.

getFaxNumber() : \CustomerCallNumberInterface

Response

\CustomerCallNumberInterface

Customer's fax number.

Returns the customer's first name.

getFirstname() : \CustomerFirstnameInterface

Response

\CustomerFirstnameInterface

Customer's first name.

Returns the customer's gender.

getGender() : \CustomerGenderInterface

Response

\CustomerGenderInterface

Customer's gender.

Returns the customer's ID.

getId() : integer

Response

integer

Customer's ID.

Returns the customer's last name.

getLastname() : \CustomerLastnameInterface

Response

\CustomerLastnameInterface

Customer's last name.

Returns the customer's password.

getPassword() : \CustomerPasswordInterface

Response

\CustomerPasswordInterface

Customer's password.

Returns the customer's status ID.

getStatusId() : integer

Response

integer

customerStatusId Customer's status ID.

Returns the customer's telephone number.

getTelephoneNumber() : \CustomerCallNumberInterface

Response

\CustomerCallNumberInterface

Customer's telephone number.

Returns the customer's VAT number.

getVatNumber() : \CustomerVatNumberInterface

Response

\CustomerVatNumberInterface

Customer's VAT number.

Returns the customer's VAT number status.

getVatNumberStatus() : integer

Response

integer

Customer's VAT number status.

Checks if customer is a guest.

isGuest() : boolean

Response

boolean

Is customer a guest?

Set Addon Value

setAddonValue(\StringType $key, \StringType $value) : \GXEngineProduct

Sets the addon value of a product.

Arguments

$key

\StringType

The key for the addon value.

$value

\StringType

The value for the addon.

Response

\GXEngineProduct

Same instance for chained method calls.

Sets the customer's number.

setCustomerNumber(\CustomerNumberInterface $customerNumber)

Arguments

$customerNumber

\CustomerNumberInterface

Customer's number.

Sets the customer's date of birth.

setDateOfBirth(\DateTime $dateOfBirth)

Arguments

$dateOfBirth

\DateTime

date of birth Customer's date of birth.

Sets the customer's default address.

setDefaultAddress(\CustomerAddressInterface $address)

Arguments

$address

\CustomerAddressInterface

Customer's default address.

Sets the customer's email.

setEmail(\CustomerEmailInterface $email)

Arguments

$email

\CustomerEmailInterface

Customer's email.

Sets the customer's fax number.

setFaxNumber(\CustomerCallNumberInterface $faxNumber)

Arguments

$faxNumber

\CustomerCallNumberInterface

Customer's fax number.

Sets the customer's first name.

setFirstname(\CustomerFirstnameInterface $firstname)

Arguments

$firstname

\CustomerFirstnameInterface

Customer's first name.

Sets the customer's gender.

setGender(\CustomerGenderInterface $gender)

Arguments

$gender

\CustomerGenderInterface

Customer's gender.

Sets the customer's guest status.

setGuest(boolean $p_isPGuest)
Throws
\InvalidArgumentException

if $p_isGuest is not a boolean value

Arguments

$p_isPGuest

boolean

Customer's guest status.

Sets the customer's ID.

setId(\IdType $id)
Throws
\InvalidArgumentException

If $p_id is not an integer or if $p_id is lower than 1.

Arguments

$id

\IdType

customerId Customer ID.

Sets the customer's last name.

setLastname(\CustomerLastnameInterface $lastname)

Arguments

$lastname

\CustomerLastnameInterface

Customer's last name.

Sets the customer's password.

setPassword(\CustomerPasswordInterface $password)

Arguments

$password

\CustomerPasswordInterface

Customer's password.

Sets the customer's status ID.

setStatusId(integer $p_statusId)
Throws
\InvalidArgumentException

Arguments

$p_statusId

integer

Customer's status ID.

Sets the customer's telephone number.

setTelephoneNumber(\CustomerCallNumberInterface $telephoneNumber)

Arguments

$telephoneNumber

\CustomerCallNumberInterface

Customer's telephone number.

Sets the customer's VAT number.

setVatNumber(\CustomerVatNumberInterface $vatNumber)

Arguments

$vatNumber

\CustomerVatNumberInterface

Customer's VAT number.

Sets the customer's VAT number status.

setVatNumberStatus(integer $p_vatNumberStatus)

Arguments

$p_vatNumberStatus

integer

Customer's VAT number status.

Properties

Customer ID.

id : integer
var

Type(s)

integer

Customer number.

customerNumber : \CustomerNumberInterface
var

Type(s)

\CustomerNumberInterface

Customer gender.

gender : \CustomerGenderInterface
var

Type(s)

\CustomerGenderInterface

Customer first name.

firstname : \CustomerFirstnameInterface
var

Type(s)

\CustomerFirstnameInterface

Customer last name.

lastname : \CustomerLastnameInterface
var

Type(s)

\CustomerLastnameInterface

Customer date of birth.

dateOfBirth : \DateTime
var

Type(s)

\DateTime

Customer VAT number.

vatNumber : \CustomerVatNumberInterface
var

Type(s)

\CustomerVatNumberInterface

Customer VAT number status.

vatNumberStatus : integer
var

Type(s)

integer

Customer call number.

telephoneNumber : \CustomerCallNumberInterface
var

Type(s)

\CustomerCallNumberInterface

Customer fax number.

faxNumber : \CustomerCallNumberInterface
var

Type(s)

\CustomerCallNumberInterface

Customer E-Mail address.

email : \CustomerEmailInterface
var

Type(s)

\CustomerEmailInterface

Customer password.

password : \CustomerPasswordInterface
var

Type(s)

\CustomerPasswordInterface

Customer default address.

defaultAddress : \CustomerAddressInterface
var

Type(s)

\CustomerAddressInterface

Customer status ID.

customerStatusId : integer
var

Type(s)

integer

Customer guest status.

isGuest : boolean
var

Type(s)

boolean

Addons collection.

addonValues : \EditableKeyValueCollection
var

Type(s)

\EditableKeyValueCollection