API Documentation
Back to top  

CustomerReadServiceInterface

Extends

Interface CustomerReadServiceInterface

category

System
package

Customer
subpackage

Interfaces

Methods

Checks if address is the default address of the customer.

addressIsDefaultCustomerAddress(\CustomerAddressInterface $customerAddress) : boolean

Arguments

$customerAddress

\CustomerAddressInterface

Customer's address.

Response

boolean

Is provided address the customer's default address?

Filters customer records and returns an array with results.

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

Example: $service->filterCustomers(['customers_id' => 1]);

Arguments

$conditions

array

Associative array containing the desired field and value.

$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 that contains customer objects.

Finds a customer by an entered ID.

getCustomerById(\IdType $customerId) : \Customer

Arguments

$customerId

\IdType

Customer ID.

Response

\Customer

Customer.

Filters customer records and returns the total count.

getFilterCustomersCount(array $conditions = array()) : integer

Example: $service->filterCustomers(['customers_id' => 1]);

Arguments

$conditions

array

Associative array containing the desired field and value.

Response

integer

Checks if the email address of the registree already exists.

registreeEmailExists(\CustomerEmailInterface $email) : boolean

Arguments

$email

\CustomerEmailInterface

Customer's E-Mail address.

Response

boolean

Does the E-Mail address already exist?

Filters customer records by a given CustomerSearchCondition object and returns an array with results.

searchCustomers(\CustomerSearchCondition $condition, \Pager|null $pager = null, array $sorters = array()) : array

Arguments

$condition

\CustomerSearchCondition

Conditions object for search.

$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 that contains customer objects.