Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AbstractCustomerServiceFactory
  • Customer
  • CustomerDeleter
  • CustomerFactory
  • CustomerReader
  • CustomerReadService
  • CustomerRepository
  • CustomerService
  • CustomerServiceFactory
  • CustomerWriter
  • CustomerWriteService

Class Customer

Class Customer

This class is used for managing customer data

Customer implements CustomerInterface
Package: Customer
Category: System
Implements: CustomerInterface
Located at Services/Core/Customer/Customer.inc.php

Methods summary

public
# __construct( )

Constructor of the class Customer

Constructor of the class Customer

public integer
# getId( )

Returns the customer's ID.

Returns the customer's ID.

Returns

integer
Customer's ID.

Implementation of

CustomerInterface::getId()
public integer
# getAddonValueContainerId( )

Returns the customer ID.

Returns the customer ID.

Returns

integer

Implementation of

AddonValueContainerInterface::getAddonValueContainerId()
public string
# getCustomerNumber( )

Returns the customer's number.

Returns the customer's number.

Returns

string
customerNumber Customer's number.

Implementation of

CustomerInterface::getCustomerNumber()
public
# setCustomerNumber( CustomerNumberInterface $customerNumber )

Sets the customer's number.

Sets the customer's number.

Parameters

$customerNumber
Customer's number.

Implementation of

CustomerInterface::setCustomerNumber()
public integer
# getStatusId( )

Returns the customer's status ID.

Returns the customer's status ID.

Returns

integer
customerStatusId Customer's status ID.

Implementation of

CustomerInterface::getStatusId()
public
# setStatusId( integer $p_statusId )

Sets the customer's status ID.

Sets the customer's status ID.

Parameters

$p_statusId
Customer's status ID.

Throws

InvalidArgumentException

Implementation of

CustomerInterface::setStatusId()
public boolean
# isGuest( )

Checks if customer is a guest.

Checks if customer is a guest.

Returns

boolean
Is customer a guest?

Implementation of

CustomerInterface::isGuest()
public CustomerGenderInterface
# getGender( )

Returns the customer's gender.

Returns the customer's gender.

Returns

CustomerGenderInterface
Customer's gender.

Implementation of

CustomerInterface::getGender()
public CustomerFirstnameInterface
# getFirstname( )

Returns the customer's first name.

Returns the customer's first name.

Returns

CustomerFirstnameInterface
Customer's first name.

Implementation of

CustomerInterface::getFirstname()
public CustomerLastnameInterface
# getLastname( )

Returns the customer's last name.

Returns the customer's last name.

Returns

CustomerLastnameInterface
Customer's last name.

Implementation of

CustomerInterface::getLastname()
public DateTime
# getDateOfBirth( )

Returns the customer's date of birth.

Returns the customer's date of birth.

Returns

DateTime
date of birth Customer's date of birth.

Implementation of

CustomerInterface::getDateOfBirth()
public CustomerVatNumberInterface
# getVatNumber( )

Returns the customer's VAT number.

Returns the customer's VAT number.

Returns

CustomerVatNumberInterface
Customer's VAT number.

Implementation of

CustomerInterface::getVatNumber()
public integer
# getVatNumberStatus( )

Returns the customer's VAT number status.

Returns the customer's VAT number status.

Returns

integer
Customer's VAT number status.

Implementation of

CustomerInterface::getVatNumberStatus()
public CustomerCallNumberInterface
# getTelephoneNumber( )

Returns the customer's telephone number.

Returns the customer's telephone number.

Returns

CustomerCallNumberInterface
Customer's telephone number.

Implementation of

CustomerInterface::getTelephoneNumber()
public CustomerCallNumberInterface
# getFaxNumber( )

Returns the customer's fax number.

Returns the customer's fax number.

Returns

CustomerCallNumberInterface
Customer's fax number.

Implementation of

CustomerInterface::getFaxNumber()
public CustomerEmailInterface
# getEmail( )

Returns the customer's email.

Returns the customer's email.

Returns

CustomerEmailInterface
Customer's email.

Implementation of

CustomerInterface::getEmail()
public CustomerPasswordInterface
# getPassword( )

Returns the customer's password.

Returns the customer's password.

Returns

CustomerPasswordInterface
Customer's password.

Implementation of

CustomerInterface::getPassword()
public CustomerAddressInterface
# getDefaultAddress( )

Returns the customer's default address.

Returns the customer's default address.

Returns

CustomerAddressInterface
Customer's default address.

Implementation of

CustomerInterface::getDefaultAddress()
public
# setGuest( boolean $p_isPGuest )

Sets the customer's guest status.

Sets the customer's guest status.

Parameters

$p_isPGuest
Customer's guest status.

Throws

InvalidArgumentException
if $p_isGuest is not a boolean value

Implementation of

CustomerInterface::setGuest()
public
# setId( IdType $id )

Sets the customer's ID.

Sets the customer's ID.

Parameters

$id
customerId Customer ID.

Throws

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

Implementation of

CustomerInterface::setId()
public
# setGender( CustomerGenderInterface $gender )

Sets the customer's gender.

Sets the customer's gender.

Parameters

$gender
Customer's gender.

Implementation of

CustomerInterface::setGender()
public
# setFirstname( CustomerFirstnameInterface $firstname )

Sets the customer's first name.

Sets the customer's first name.

Parameters

$firstname
Customer's first name.

Implementation of

CustomerInterface::setFirstname()
public
# setLastname( CustomerLastnameInterface $lastname )

Sets the customer's last name.

Sets the customer's last name.

Parameters

$lastname
Customer's last name.

Implementation of

CustomerInterface::setLastname()
public
# setDateOfBirth( DateTime $dateOfBirth )

Sets the customer's date of birth.

Sets the customer's date of birth.

Parameters

$dateOfBirth
date of birth Customer's date of birth.

Implementation of

CustomerInterface::setDateOfBirth()
public
# setVatNumber( CustomerVatNumberInterface $vatNumber )

Sets the customer's VAT number.

Sets the customer's VAT number.

Parameters

$vatNumber
Customer's VAT number.

Implementation of

CustomerInterface::setVatNumber()
public
# setVatNumberStatus( integer $p_vatNumberStatus )

Sets the customer's VAT number status.

Sets the customer's VAT number status.

Parameters

$p_vatNumberStatus
Customer's VAT number status.

Implementation of

CustomerInterface::setVatNumberStatus()
public
# setTelephoneNumber( CustomerCallNumberInterface $telephoneNumber )

Sets the customer's telephone number.

Sets the customer's telephone number.

Parameters

$telephoneNumber
Customer's telephone number.

Implementation of

CustomerInterface::setTelephoneNumber()
public
# setFaxNumber( CustomerCallNumberInterface $faxNumber )

Sets the customer's fax number.

Sets the customer's fax number.

Parameters

$faxNumber
Customer's fax number.

Implementation of

CustomerInterface::setFaxNumber()
public
# setEmail( CustomerEmailInterface $email )

Sets the customer's email.

Sets the customer's email.

Parameters

$email
Customer's email.

Implementation of

CustomerInterface::setEmail()
public
# setPassword( CustomerPasswordInterface $password )

Sets the customer's password.

Sets the customer's password.

Parameters

$password
Customer's password.

Implementation of

CustomerInterface::setPassword()
public
# setDefaultAddress( CustomerAddressInterface $address )

Sets the customer's default address.

Sets the customer's default address.

Parameters

$address
Customer's default address.

Implementation of

CustomerInterface::setDefaultAddress()
public string
# getAddonValue( StringType $key )

Get Addon Value

Get Addon Value

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

Parameters

$key
The key of the addon value to return.

Returns

string
The addon value.

Throws

InvalidArgumentException
if the key is not valid.

Implementation of

AddonValueContainerInterface::getAddonValue()
public KeyValueCollection
# getAddonValues( )

Get Addon Values

Get Addon Values

Returns a key value collection of the product.

Returns

KeyValueCollection
The key value collection.

Implementation of

AddonValueContainerInterface::getAddonValues()
public GXEngineProduct
# setAddonValue( StringType $key, StringType $value )

Set Addon Value

Set Addon Value

Sets the addon value of a product.

Parameters

$key
The key for the addon value.
$value
The value for the addon.

Returns

GXEngineProduct
Same instance for chained method calls.

Implementation of

AddonValueContainerInterface::setAddonValue()
public GXEngineProduct
# addAddonValues( KeyValueCollection $keyValueCollection )

Add Addon Values

Add Addon Values

Adds a key value collection to a product.

Parameters

$keyValueCollection
The key value collection to add.

Returns

GXEngineProduct
Same instance for chained method calls.

Implementation of

AddonValueContainerInterface::addAddonValues()
public GXEngineProduct
# deleteAddonValue( StringType $key )

Delete Addon Value

Delete Addon Value

Deletes an addon value of a product.

Parameters

$key
The key of the addon value to delete.

Returns

GXEngineProduct
Same instance for chained method calls.

Throws

InvalidArgumentException
if the key is not valid.

Implementation of

AddonValueContainerInterface::deleteAddonValue()

Properties summary

protected integer $id

Customer ID.

Customer ID.

#
protected CustomerNumberInterface $customerNumber

Customer number.

Customer number.

#
protected CustomerGenderInterface $gender

Customer gender.

Customer gender.

#
protected CustomerFirstnameInterface $firstname

Customer first name.

Customer first name.

#
protected CustomerLastnameInterface $lastname

Customer last name.

Customer last name.

#
protected DateTime $dateOfBirth

Customer date of birth.

Customer date of birth.

#
protected CustomerVatNumberInterface $vatNumber

Customer VAT number.

Customer VAT number.

#
protected integer $vatNumberStatus

Customer VAT number status.

Customer VAT number status.

# 0
protected CustomerCallNumberInterface $telephoneNumber

Customer call number.

Customer call number.

#
protected CustomerCallNumberInterface $faxNumber

Customer fax number.

Customer fax number.

#
protected CustomerEmailInterface $email

Customer E-Mail address.

Customer E-Mail address.

#
protected CustomerPasswordInterface $password

Customer password.

Customer password.

#
protected CustomerAddressInterface $defaultAddress

Customer default address.

Customer default address.

#
protected integer $customerStatusId

Customer status ID.

Customer status ID.

# 0
protected boolean $isGuest

Customer guest status.

Customer guest status.

# false
protected EditableKeyValueCollection $addonValues

Addons collection.

Addons collection.

#
API documentation generated by ApiGen