phpDocumentor

ParcelServiceFilterService

Interface ParcelServiceFilterService

Table of Contents

filterParcelServices()  : ParcelServices
Returns a filtered and paginated collection of parcel services based on the given filter and sorting arguments.
getParcelServicesTotalCount()  : int
Returns total count of parcel services based on the given filter arguments.

Methods

filterParcelServices()

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

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

The filters must be a map, that assigns an attribute it 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
ParcelServices

getParcelServicesTotalCount()

Returns total count of parcel services based on the given filter arguments.

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

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

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

Search results