ParcelServiceRepository
in
Interface ParcelServiceRepository
Table of Contents
- createMultipleParcelServices() : ParcelServiceIds
- Creates multiple parcel services and returns their IDs.
- createParcelService() : ParcelServiceId
- Creates a new parcel service and returns its ID.
- deleteParcelServices() : void
- Deletes parcel services based on the given IDs.
- filterParcelServices() : ParcelServices
- Returns a filtered and paginated collection of parcel services based on the given filter and sorting arguments.
- getAllParcelServices() : ParcelServices
- Returns all available parcel services.
- getParcelServiceById() : ParcelService
- Returns a specific parcel service based on the given ID.
- getParcelServicesTotalCount() : int
- Returns total count of parcel services based on the given filter arguments.
- storeParcelServices() : void
- Stores multiple parcel services.
Methods
createMultipleParcelServices()
Creates multiple parcel services and returns their IDs.
public
createMultipleParcelServices(array<string|int, mixed> ...$creationArguments) : ParcelServiceIds
Parameters
- $creationArguments : array<string|int, mixed>
-
Provided array must contain arguments like they are used in the single creation method. Provide multiple arrays for multi creation.
Tags
Return values
ParcelServiceIds —createParcelService()
Creates a new parcel service and returns its ID.
public
createParcelService(string $name, ParcelServiceDescriptions $descriptions[, bool $isDefault = false ][, string $shipmentType = '' ]) : ParcelServiceId
Parameters
- $name : string
- $descriptions : ParcelServiceDescriptions
- $isDefault : bool = false
- $shipmentType : string = ''
Tags
Return values
ParcelServiceId —deleteParcelServices()
Deletes parcel services based on the given IDs.
public
deleteParcelServices(ParcelServiceId ...$ids) : void
Parameters
- $ids : ParcelServiceId
Tags
Return values
void —filterParcelServices()
Returns a filtered and paginated collection of parcel services based on the given filter and sorting arguments.
public
filterParcelServices(Filters $filters, Sorting $sorting, Pagination $pagination) : ParcelServices
Parameters
- $filters : Filters
- $sorting : Sorting
- $pagination : Pagination
Return values
ParcelServices —getAllParcelServices()
Returns all available parcel services.
public
getAllParcelServices() : ParcelServices
Return values
ParcelServices —getParcelServiceById()
Returns a specific parcel service based on the given ID.
public
getParcelServiceById(ParcelServiceId $id) : ParcelService
Parameters
- $id : ParcelServiceId
Tags
Return values
ParcelService —getParcelServicesTotalCount()
Returns total count of parcel services based on the given filter arguments.
public
getParcelServicesTotalCount(Filters $criteria) : int
Parameters
- $criteria : Filters
Return values
int —storeParcelServices()
Stores multiple parcel services.
public
storeParcelServices(ParcelService ...$parcelServices) : void
Parameters
- $parcelServices : ParcelService