phpDocumentor

CustomerSearchService

Interface CustomerSearchService

Table of Contents

getSearchedCustomerTotalCount()  : int
Returns total count of customers based on the given search object.
searchCustomers()  : Customers
Returns a paginated collection of customers based on the given search term and sorting arguments.

Methods

getSearchedCustomerTotalCount()

Returns total count of customers based on the given search object.

public getSearchedCustomerTotalCount(string $searchTerm) : int
Parameters
$searchTerm : string
Return values
int

searchCustomers()

Returns a paginated collection of customers based on the given search term and sorting arguments.

public searchCustomers(string $searchTerm[, string|null $sorting = null ][, int $limit = 25 ], int $offset) : Customers

The sorting must be a comma-separated list of attributes. A - can be used to change the order to descending.

Parameters
$searchTerm : string
$sorting : string|null = null
$limit : int = 25
$offset : int
Return values
Customers

Search results