CustomerAddressReaderInterface
in
Interface CustomerAddressReaderInterface
Tags
Table of Contents
- filterAddresses() : array<string|int, mixed>
- Filter existing addresses by keyword.
- findAddressesByCustomer() : array<string|int, mixed>
- Method to find customer addresses with a given customer Returns an array of all customer's addresses
- findById() : CustomerAddress|null
- Method to find a customer address with a given ID if it exits else it will return null
- getAllAddresses() : array<string|int, mixed>
- Get all system addresses.
Methods
filterAddresses()
Filter existing addresses by keyword.
public
filterAddresses(string $p_keyword[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : array<string|int, mixed>
This method is useful when creating a search mechanism for the registered addresses.
Parameters
- $p_keyword : string
-
The keyword to be used for filtering the records.
- $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.
findAddressesByCustomer()
Method to find customer addresses with a given customer Returns an array of all customer's addresses
public
findAddressesByCustomer(CustomerInterface $customer) : array<string|int, mixed>
Parameters
- $customer : CustomerInterface
Return values
array<string|int, mixed> —containing CustomerAddress objects
findById()
Method to find a customer address with a given ID if it exits else it will return null
public
findById(IdType $id) : CustomerAddress|null
Parameters
- $id : IdType
Tags
Return values
CustomerAddress|null —getAllAddresses()
Get all system addresses.
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.