phpDocumentor

CustomerFilterService

Interface CustomerFilterService

Table of Contents

filterCustomers()  : Customers
Returns a filtered and paginated collection of customers based on the given filter and sorting arguments.
getCustomersTotalCount()  : int
Returns total count of customers based on the given filter arguments.

Methods

filterCustomers()

Returns a filtered and paginated collection of customers based on the given filter and sorting arguments.

public filterCustomers(array<string|int, mixed> $filters[, string|null $sorting = null ][, int $limit = 25 ], int $offset) : Customers

The filters must be a map, that assigns an attribute its filtering pattern. The sorting must be a comma-separated list of attributes. A - can be used to change the order to descending.

Parameters
$filters : array<string|int, mixed>
$sorting : string|null = null
$limit : int = 25
$offset : int
Return values
Customers

getCustomersTotalCount()

Returns total count of customers based on the given filter arguments.

public getCustomersTotalCount(array<string|int, mixed> $filters) : int

The filters must be a map, that assigns an attribute it's filtering pattern.

Parameters
$filters : array<string|int, mixed>
Return values
int

Search results