phpDocumentor

PersonalDataService
in package
implements PersonalDataServiceInterface

Class PersonalDataService

Interfaces, Classes and Traits

PersonalDataServiceInterface
Interface PersonalDataServiceInterface

Table of Contents

$addressBookService  : AddressBookService
$agreementReadService  : AgreementReadServiceInterface
$agreementWriteService  : AgreementWriteServiceInterface
$customerReadService  : CustomerReadServiceInterface
$customerService  : CustomerService
$emailService  : EmailServiceInterface
$invoiceArchiveReadService  : InvoiceArchiveReadServiceInterface
$invoiceArchiveWriteService  : InvoiceArchiveWriteServiceInterface
$invoiceFileStorage  : PersonalDataInvoiceFileStorageInterface
$newsletterSubscriptionService  : NewsletterSubscriptionServiceInterface
$orderReadService  : OrderReadServiceInterface
$orderWriteService  : OrderWriteServiceInterface
$packingSlipFileStorage  : PersonalDataPackingSlipFileStorageInterface
$packingSlipService  : PackingSlipServiceInterface
$reviewReadService  : ReviewReadServiceInterface
$reviewWriteService  : ReviewWriteServiceInterface
$serviceSettings  : PersonalDataServiceSettingsInterface
$sharedShoppingCartService  : SharedShoppingCartServiceInterface
$shoppingCartService  : ShoppingCartServiceInterface
$withdrawalReadService  : WithdrawalReadServiceInterface
$withdrawalWriteService  : WithdrawalWriteServiceInterface
$xmlSerializer  : PersonalDataXmlSerializer
$customerFactory  : CustomerFactory
$eventDispatcher  : EventDispatcherInterface
$withdrawalFactory  : WithdrawalFactory
__construct()  : mixed
PersonalDataService constructor.
deletePersonalDataByCustomerId()  : mixed
Deletes all data for a given customer. The following personal data will be deleted:
exportPersonalDataByCustomerId()  : string
Exports all personal data of a given customer as XML including the following data:
setInvoiceArchiveReadService()  : mixed
setInvoiceArchiveWriteService()  : mixed
setPackingSlipService()  : mixed
buildZipFile()  : mixed
copyFilesToExport()  : mixed
createCustomerDirectory()  : mixed
createXmlFile()  : mixed
createZipFile()  : mixed
deleteAddressesByCustomer()  : mixed
deleteAgreementsByCustomer()  : mixed
deleteCustomerById()  : mixed
deleteEmailsByCustomerEmailAddress()  : mixed
deleteInvoicesByCustomerId()  : mixed
deleteNewsletterSubscriptionByCustomerEmail()  : mixed
deleteOrdersByOrderList()  : mixed
deletePackingSlipsByOrderList()  : mixed
deleteReviewsByCustomerId()  : mixed
deleteSharedShoppingCartsByCustomerId()  : mixed
deleteShoppingCartsByCustomerId()  : mixed
deleteWithdrawalsByOrderList()  : mixed
getAddressesByCustomer()  : array<string|int, mixed>
getAgreementsByCustomer()  : AgreementCollection
getCustomerById()  : Customer
getEmailsByCustomerEmailAddress()  : EmailCollection
getInvoicesByCustomerId()  : InvoiceListItemCollection
getNewsletterSubscriptionByCustomerEmail()  : bool|NewsletterSubscription
getOrderListByCustomerId()  : OrderListItemCollection
getOrdersByOrderList()  : mixed
getPackingSlipsByOrderList()  : PackingSlipCollection
getReviewsByCustomerId()  : ReviewCollection
getSharedShoppingCartsByCustomerId()  : SharedShoppingCartCollection
getShoppingCartsByCustomerId()  : ShoppingCartCollection
getWithdrawalsByOrderList()  : WithdrawalCollection
createCustomerDeletedEvent()  : CustomerDeleted
createWithdrawalDeletedEvent()  : WithdrawalDeleted

Properties

Methods

__construct()

PersonalDataService constructor.

public __construct(OrderReadServiceInterface $orderReadService, OrderWriteServiceInterface $orderWriteService, CustomerReadService $customerReadService, CustomerService $customerService, EmailServiceInterface $emailService, WithdrawalReadServiceInterface $withdrawalReadService, WithdrawalWriteServiceInterface $withdrawalWriteService, ReviewReadServiceInterface $reviewReadService, ReviewWriteServiceInterface $reviewWriteService, ShoppingCartServiceInterface $shoppingCartService, SharedShoppingCartServiceInterface $sharedShoppingCartService, NewsletterSubscriptionServiceInterface $newsletterSubscriptionService, AddressBookService $addressBookService, AgreementWriteServiceInterface $agreementWriteService, AgreementReadServiceInterface $agreementReadService, PersonalDataInvoiceFileStorageInterface $invoiceFileStorage, PersonalDataPackingSlipFileStorageInterface $packingSlipFileStorage, PersonalDataServiceSettingsInterface $serviceSettings, PersonalDataXmlSerializer $xmlSerializer) : mixed
Parameters
$orderReadService : OrderReadServiceInterface
$orderWriteService : OrderWriteServiceInterface
$customerReadService : CustomerReadService
$customerService : CustomerService
$emailService : EmailServiceInterface
$withdrawalReadService : WithdrawalReadServiceInterface
$withdrawalWriteService : WithdrawalWriteServiceInterface
$reviewReadService : ReviewReadServiceInterface
$reviewWriteService : ReviewWriteServiceInterface
$shoppingCartService : ShoppingCartServiceInterface
$sharedShoppingCartService : SharedShoppingCartServiceInterface
$newsletterSubscriptionService : NewsletterSubscriptionServiceInterface
$addressBookService : AddressBookService
$agreementWriteService : AgreementWriteServiceInterface
$agreementReadService : AgreementReadServiceInterface
$invoiceFileStorage : PersonalDataInvoiceFileStorageInterface
$packingSlipFileStorage : PersonalDataPackingSlipFileStorageInterface
$serviceSettings : PersonalDataServiceSettingsInterface
$xmlSerializer : PersonalDataXmlSerializer
Return values
mixed —

deletePersonalDataByCustomerId()

Deletes all data for a given customer. The following personal data will be deleted:

public deletePersonalDataByCustomerId(IdType $customerId, PersonalDataSelection $selection) : mixed
  • base data
  • addresses
  • orders
  • invoices
  • packing slips
  • withdrawals
  • agreements
  • emails
  • shopping carts
  • shared shopping carts
  • reviews
  • newsletter subscriptions
Parameters
$customerId : IdType

Customer ID

$selection : PersonalDataSelection

Personal data selection

Return values
mixed —

exportPersonalDataByCustomerId()

Exports all personal data of a given customer as XML including the following data:

public exportPersonalDataByCustomerId(IdType $customerId, PersonalDataSelection $selection) : string
  • base data
  • addresses
  • orders
  • invoices
  • packing slips
  • withdrawals
  • agreements
  • emails
  • shopping carts
  • shared shopping carts
  • reviews
  • newsletter subscriptions

The XML file and all invoices and packing slips of the customer are compressed to a ZIP file. The path to the ZIP file is then returned.

Parameters
$customerId : IdType
$selection : PersonalDataSelection

Personal data selection

Tags
throws
InvalidArgumentException
Return values
string —

.

deleteInvoicesByCustomerId()

protected deleteInvoicesByCustomerId(IdType $customerId) : mixed
Parameters
$customerId : IdType
Tags
throws
InvalidArgumentException
Return values
mixed —

deleteSharedShoppingCartsByCustomerId()

protected deleteSharedShoppingCartsByCustomerId(IdType $customerId) : mixed
Parameters
$customerId : IdType
Return values
mixed —

deleteShoppingCartsByCustomerId()

protected deleteShoppingCartsByCustomerId(IdType $customerId) : mixed
Parameters
$customerId : IdType
Return values
mixed —

getAddressesByCustomer()

protected getAddressesByCustomer(Customer $customer) : array<string|int, mixed>
Parameters
$customer : Customer
Return values
array<string|int, mixed> —

createCustomerDeletedEvent()

private createCustomerDeletedEvent(IdType $customerId) : CustomerDeleted
Parameters
$customerId : IdType
Return values
CustomerDeleted —

createWithdrawalDeletedEvent()

private createWithdrawalDeletedEvent(IdType $withdrawalId) : WithdrawalDeleted
Parameters
$withdrawalId : IdType
Return values
WithdrawalDeleted —

Search results