CustomerAddressRepositoryInterface
in
Interface CustomerAddressRepositoryInterface
Tags
Table of Contents
- deleteCustomerAddress() : mixed
- Method to delete a customer address
- deleteCustomerAddressesByCustomer() : mixed
- Method to delete all customers addresses with a given customer
- filterAddresses() : array<string|int, mixed>
- Filter existing address records by provided string.
- findById() : CustomerAddress|null
- Method to find a customer address with a given ID it it exists else it will return null
- getAllAddresses() : array<string|int, mixed>
- Get all registered address records.
- getById() : CustomerAddress
- Method to get a customer address with a given ID
- getCustomerAddresses() : array<string|int, mixed>
- Method to get all customers addresses
- store() : CustomerAddressInterface
- Method to store the customer address
Methods
deleteCustomerAddress()
Method to delete a customer address
public
deleteCustomerAddress(CustomerAddressInterface $address) : mixed
Parameters
- $address : CustomerAddressInterface
Return values
mixed —deleteCustomerAddressesByCustomer()
Method to delete all customers addresses with a given customer
public
deleteCustomerAddressesByCustomer(CustomerInterface $customer) : mixed
Parameters
- $customer : CustomerInterface
Return values
mixed —filterAddresses()
Filter existing address records by provided string.
public
filterAddresses(string $p_keyword[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : array<string|int, mixed>
Parameters
- $p_keyword : string
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
array<string|int, mixed> —Returns an array of CustomerAddress objects.
findById()
Method to find a customer address with a given ID it it exists else it will return null
public
findById(IdType $addressBookId) : CustomerAddress|null
Parameters
- $addressBookId : IdType
Return values
CustomerAddress|null —getAllAddresses()
Get all registered address records.
public
getAllAddresses([Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : array<string|int, mixed>
Parameters
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
array<string|int, mixed> —Returns an array of CustomerAddress objects.
getById()
Method to get a customer address with a given ID
public
getById(IdType $addressBookId) : CustomerAddress
Parameters
- $addressBookId : IdType
Return values
CustomerAddress —getCustomerAddresses()
Method to get all customers addresses
public
getCustomerAddresses(CustomerInterface $customer) : array<string|int, mixed>
Parameters
- $customer : CustomerInterface
Return values
array<string|int, mixed> —of CustomerAddress objects
store()
Method to store the customer address
public
store(CustomerAddressInterface $address) : CustomerAddressInterface
Parameters
- $address : CustomerAddressInterface