PersonalDataService

Implements \PersonalDataServiceInterface

Class PersonalDataService

package

Default

Methods

PersonalDataService constructor.

__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) 

Arguments

$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

buildZipFile

buildZipFile(\StringType $customerHash, \StringType $xmlString, \ExistingFileCollection $invoices, \ExistingFileCollection $packingSlips) 
Throws
\InvalidArgumentException

Arguments

$customerHash

\StringType

$xmlString

\StringType

$packingSlips

\ExistingFileCollection

copyFilesToExport

copyFilesToExport(\StringType $directoryPath, \ExistingFileCollection $files) 

Arguments

$directoryPath

\StringType

createCustomerDirectory

createCustomerDirectory(\StringType $directoryPath) 
Throws
\DirectoryCreationFailedException

Arguments

$directoryPath

\StringType

createXmlFile

createXmlFile(\StringType $directoryPath, \StringType $xmlString) 

Arguments

$directoryPath

\StringType

$xmlString

\StringType

createZipFile

createZipFile(\StringType $directoryPath, \StringType $customerHash) 

Arguments

$directoryPath

\StringType

$customerHash

\StringType

deleteAddressesByCustomer

deleteAddressesByCustomer(\CustomerInterface $customer) 

Arguments

$customer

\CustomerInterface

deleteAgreementsByCustomer

deleteAgreementsByCustomer(\CustomerInterface $customer) 

Arguments

$customer

\CustomerInterface

deleteCustomerById

deleteCustomerById(\IdType $customerId) 

Arguments

$customerId

\IdType

deleteEmailsByCustomerEmailAddress

deleteEmailsByCustomerEmailAddress(\CustomerEmail $customerEmail) 

Arguments

$customerEmail

\CustomerEmail

deleteInvoicesByCustomerId

deleteInvoicesByCustomerId(\IdType $customerId) 
Throws
\InvalidArgumentException

Arguments

$customerId

\IdType

deleteNewsletterSubscriptionByCustomerEmail

deleteNewsletterSubscriptionByCustomerEmail(\CustomerEmailInterface $email) 

Arguments

deleteOrdersByOrderList

deleteOrdersByOrderList(\OrderListItemCollection $orderList) 
Throws
\InvalidArgumentException

Arguments

deletePackingSlipsByOrderList

deletePackingSlipsByOrderList(\OrderListItemCollection $orderList) 
Throws
\InvalidArgumentException

Arguments

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

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

Arguments

$customerId

\IdType

Customer ID

$selection

\PersonalDataSelection

Personal data selection

deleteReviewsByCustomerId

deleteReviewsByCustomerId(\IdType $customerId) 

Arguments

$customerId

\IdType

deleteSharedShoppingCartsByCustomerId

deleteSharedShoppingCartsByCustomerId(\IdType $customerId) 

Arguments

$customerId

\IdType

deleteShoppingCartsByCustomerId

deleteShoppingCartsByCustomerId(\IdType $customerId) 

Arguments

$customerId

\IdType

deleteWithdrawalsByOrderList

deleteWithdrawalsByOrderList(\OrderListItemCollection $orderList) 

Arguments

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

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.

Throws
\InvalidArgumentException

Arguments

$customerId

\IdType

$selection

\PersonalDataSelection

Personal data selection

Response

string

.

getAddressesByCustomer

getAddressesByCustomer(\Customer $customer) : array

Arguments

$customer

\Customer

Response

array

getAgreementsByCustomer

getAgreementsByCustomer(\CustomerInterface $customer) : \AgreementCollection

Arguments

$customer

\CustomerInterface

Response

\AgreementCollection

getCustomerById

getCustomerById(\IdType $customerId) : \Customer

Arguments

$customerId

\IdType

Response

\Customer

getEmailsByCustomerEmailAddress

getEmailsByCustomerEmailAddress(\CustomerEmail $email) : \EmailCollection

Arguments

Response

\EmailCollection

getInvoicesByCustomerId

getInvoicesByCustomerId(\IdType $customerId) : \InvoiceListItemCollection

Arguments

$customerId

\IdType

Response

\InvoiceListItemCollection

getNewsletterSubscriptionByCustomerEmail

getNewsletterSubscriptionByCustomerEmail(\CustomerEmail $email) : boolean|\NewsletterSubscription

Arguments

Response

boolean|\NewsletterSubscription

getOrderListByCustomerId

getOrderListByCustomerId(\IdType $customerId) : \OrderListItemCollection

Arguments

$customerId

\IdType

Response

\OrderListItemCollection

getOrdersByOrderList

getOrdersByOrderList(\OrderListItemCollection $orderList) 

Arguments

getPackingSlipsByOrderList

getPackingSlipsByOrderList(\OrderListItemCollection $orders) : \PackingSlipCollection

getReviewsByCustomerId

getReviewsByCustomerId(\IdType $customerId) : \ReviewCollection

Arguments

$customerId

\IdType

Response

\ReviewCollection

getSharedShoppingCartsByCustomerId

getSharedShoppingCartsByCustomerId(\IdType $customerId) : \SharedShoppingCartCollection

Arguments

$customerId

\IdType

Response

\SharedShoppingCartCollection

getShoppingCartsByCustomerId

getShoppingCartsByCustomerId(\IdType $customerId) : \ShoppingCartCollection

Arguments

$customerId

\IdType

Response

\ShoppingCartCollection

getWithdrawalsByOrderList

getWithdrawalsByOrderList(\OrderListItemCollection $orderList) : \WithdrawalCollection

Arguments

Response

\WithdrawalCollection

setInvoiceArchiveReadService

setInvoiceArchiveReadService(\InvoiceArchiveReadServiceInterface $invoiceArchiveReadService) 

Arguments

$invoiceArchiveReadService

\InvoiceArchiveReadServiceInterface

setInvoiceArchiveWriteService

setInvoiceArchiveWriteService(\InvoiceArchiveWriteServiceInterface $invoiceArchiveWriteService) 

Arguments

$invoiceArchiveWriteService

\InvoiceArchiveWriteServiceInterface

setPackingSlipService

setPackingSlipService(\PackingSlipServiceInterface $packingSlipService) 

Arguments

$packingSlipService

\PackingSlipServiceInterface

Properties

orderReadService

orderReadService : \OrderReadServiceInterface

orderWriteService

orderWriteService : \OrderWriteServiceInterface

invoiceArchiveReadService

invoiceArchiveReadService : \InvoiceArchiveReadServiceInterface

invoiceArchiveWriteService

invoiceArchiveWriteService : \InvoiceArchiveWriteServiceInterface

packingSlipService

packingSlipService : \PackingSlipServiceInterface

customerReadService

customerReadService : \CustomerReadServiceInterface

customerService

customerService : \CustomerService
var

Type(s)

\CustomerService

emailService

emailService : \EmailServiceInterface

withdrawalReadService

withdrawalReadService : \WithdrawalReadServiceInterface

withdrawalWriteService

withdrawalWriteService : \WithdrawalWriteServiceInterface

reviewReadService

reviewReadService : \ReviewReadServiceInterface

reviewWriteService

reviewWriteService : \ReviewWriteServiceInterface

shoppingCartService

shoppingCartService : \ShoppingCartServiceInterface

sharedShoppingCartService

sharedShoppingCartService : \SharedShoppingCartServiceInterface

newsletterSubscriptionService

newsletterSubscriptionService : \NewsletterSubscriptionServiceInterface

addressBookService

addressBookService : \AddressBookService
var

Type(s)

\AddressBookService

agreementWriteService

agreementWriteService : \AgreementWriteServiceInterface

agreementReadService

agreementReadService : \AgreementReadServiceInterface

invoiceFileStorage

invoiceFileStorage : \PersonalDataInvoiceFileStorageInterface

packingSlipFileStorage

packingSlipFileStorage : \PersonalDataPackingSlipFileStorageInterface

serviceSettings

serviceSettings : \PersonalDataServiceSettingsInterface

xmlSerializer

xmlSerializer : \PersonalDataXmlSerializer