API Documentation
Back to top  

CustomerAddressReaderInterface

Extends

Interface CustomerAddressReaderInterface

category

System
package

Customer
subpackage

Interfaces

Methods

Filter existing addresses by keyword.

filterAddresses(string $p_keyword, \Pager|null $pager = null, array $sorters = array()) : array

This method is useful when creating a search mechanism for the registered addresses.

Arguments

$p_keyword

string

The keyword to be used for filtering the records.

$pager

\Pager|null

(Optional) Pager object with pagination information

$sorters

array

(Optional) array of Sorter objects with data sorting information

Response

array

Returns an array of CustomerAddress objects.

Method to find customer addresses with a given customer Returns an array of all customer's addresses

findAddressesByCustomer(\CustomerInterface $customer) : array

Arguments

$customer

\CustomerInterface

Response

array

containing CustomerAddress objects

Method to find a customer address with a given ID if it exits else it will return null

findById(\IdType $id) : \CustomerAddress|null
Throws
\InvalidArgumentException

Arguments

$id

\IdType

Response

\CustomerAddress|null

Get all system addresses.

getAllAddresses(\Pager|null $pager = null, array $sorters = array()) : array

Arguments

$pager

\Pager|null

(Optional) Pager object with pagination information

$sorters

array

(Optional) array of Sorter objects with data sorting information

Response

array

Returns an array of CustomerAddress objects.