API Documentation
Back to top  

CustomerAddressRepositoryInterface

Extends

Interface CustomerAddressRepositoryInterface

category

System
package

Customer
subpackage

Interfaces

Methods

Method to delete a customer address

deleteCustomerAddress(\CustomerAddressInterface $address)

Arguments

$address

\CustomerAddressInterface

Method to delete all customers addresses with a given customer

deleteCustomerAddressesByCustomer(\CustomerInterface $customer)

Arguments

$customer

\CustomerInterface

Filter existing address records by provided string.

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

Arguments

$p_keyword

string

$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 a customer address with a given ID it it exists else it will return null

findById(\IdType $addressBookId) : \CustomerAddress|null

Arguments

$addressBookId

\IdType

Response

\CustomerAddress|null

Get all registered address records.

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.

Method to get a customer address with a given ID

getById(\IdType $addressBookId) : \CustomerAddress

Arguments

$addressBookId

\IdType

Response

\CustomerAddress

Method to get all customers addresses

getCustomerAddresses(\CustomerInterface $customer) : array

Arguments

$customer

\CustomerInterface

Response

array

of CustomerAddress objects

Method to store the customer address

store(\CustomerAddressInterface $address) : \CustomerAddressInterface

Arguments

$address

\CustomerAddressInterface

Response

\CustomerAddressInterface