CustomerWriteService
in package
implements
CustomerWriteServiceInterface
Class CustomerWriteService
This class provides methods for creating and deleting customer data
Tags
Interfaces, Classes and Traits
- CustomerWriteServiceInterface
- Interface CustomerWriteServiceInterface
Table of Contents
- $addressBookService : AddressBookServiceInterface
- Address book service.
- $customerRepository : CustomerRepositoryInterface
- Customer repository.
- $customerServiceSettings : CustomerServiceSettingsInterface
- Customer service settings.
- $deleteHistory : DeleteHistoryWriteService
- $vatNumberValidator : VatNumberValidatorInterface
- VAT number validator.
- __construct() : mixed
- Constructor of the class CustomerService.
- createNewGuest() : Customer
- Creates a new guest account with the given parameters.
- createNewRegistree() : Customer
- Creates a new customer with the given parameters.
- deleteCustomerById() : mixed
- Deletes the customer with the provided ID.
- updateCustomer() : CustomerInterface
- Updates customer data.
Properties
$addressBookService
Address book service.
protected
AddressBookServiceInterface
$addressBookService
$customerRepository
Customer repository.
protected
CustomerRepositoryInterface
$customerRepository
$customerServiceSettings
Customer service settings.
protected
CustomerServiceSettingsInterface
$customerServiceSettings
$deleteHistory
protected
DeleteHistoryWriteService
$deleteHistory
$vatNumberValidator
VAT number validator.
protected
VatNumberValidatorInterface
$vatNumberValidator
Methods
__construct()
Constructor of the class CustomerService.
public
__construct(AddressBookServiceInterface $addressBookService, CustomerRepositoryInterface $customerRepository, CustomerServiceSettingsInterface $customerServiceSettings, VatNumberValidatorInterface $vatNumberValidator, DeleteHistoryWriteService $deleteHistoryWriteService) : mixed
Parameters
- $addressBookService : AddressBookServiceInterface
-
Address book service.
- $customerRepository : CustomerRepositoryInterface
-
Customer repository.
- $customerServiceSettings : CustomerServiceSettingsInterface
-
Customer service settings.
- $vatNumberValidator : VatNumberValidatorInterface
-
VAT number validator.
- $deleteHistoryWriteService : DeleteHistoryWriteService
Return values
mixed —createNewGuest()
Creates a new guest account with the given parameters.
public
createNewGuest(CustomerEmailInterface $email, DateTime $dateOfBirth, CustomerVatNumberInterface $vatNumber, CustomerCallNumberInterface $telephoneNumber, CustomerCallNumberInterface $faxNumber, AddressBlockInterface $addressBlock, KeyValueCollection $addonValues[, CustomerNumberInterface|null $customerNumber = null ]) : Customer
Parameters
- $email : CustomerEmailInterface
-
Customer's E-Mail address.
- $dateOfBirth : DateTime
-
Customer's date of birth.
- $vatNumber : CustomerVatNumberInterface
-
Customer's VAT number.
- $telephoneNumber : CustomerCallNumberInterface
-
Customer's telephone number.
- $faxNumber : CustomerCallNumberInterface
-
Customer's fax number.
- $addressBlock : AddressBlockInterface
-
Customer's address.
- $addonValues : KeyValueCollection
-
Customer's additional values.
- $customerNumber : CustomerNumberInterface|null = null
-
Customer's number.
Tags
Return values
Customer —Created guest customer.
createNewRegistree()
Creates a new customer with the given parameters.
public
createNewRegistree(CustomerEmailInterface $email, CustomerPasswordInterface $password, DateTime $dateOfBirth, CustomerVatNumberInterface $vatNumber, CustomerCallNumberInterface $telephoneNumber, CustomerCallNumberInterface $faxNumber, AddressBlockInterface $addressBlock, KeyValueCollection $addonValues[, CustomerNumberInterface|null $customerNumber = null ]) : Customer
Will create a guest account if $password is an instance of CustomerGuestPassword.
Parameters
- $email : CustomerEmailInterface
-
Customer's E-Mail address.
- $password : CustomerPasswordInterface
-
Customer's password.
- $dateOfBirth : DateTime
-
Customer's date of birth.
- $vatNumber : CustomerVatNumberInterface
-
Customer's VAT number.
- $telephoneNumber : CustomerCallNumberInterface
-
Customer's telephone number.
- $faxNumber : CustomerCallNumberInterface
-
Customer's fax number.
- $addressBlock : AddressBlockInterface
-
Customer's address.
- $addonValues : KeyValueCollection
-
Customer's additional values.
- $customerNumber : CustomerNumberInterface|null = null
-
Customer's number.
Tags
Return values
Customer —Created customer.
deleteCustomerById()
Deletes the customer with the provided ID.
public
deleteCustomerById(IdType $customerId) : mixed
Parameters
- $customerId : IdType
-
Customer's ID.
Return values
mixed —updateCustomer()
Updates customer data.
public
updateCustomer(CustomerInterface $customer) : CustomerInterface
Parameters
- $customer : CustomerInterface
-
Customer.
Return values
CustomerInterface —Updated customer.
TODO check if the new email address is used by another record