Download the PHP package componenta/http-pagination without Composer
On this page you can find all versions of the php package componenta/http-pagination. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download componenta/http-pagination
More information about componenta/http-pagination
Files in componenta/http-pagination
Package http-pagination
Short Description HTTP pagination URL helpers for Componenta
License MIT
Informations about the package http-pagination
Componenta HTTP Pagination
HTTP helpers for paginated resources. The package connects componenta/paginator with PSR-7 request URIs and response arrays.
Use this package when an HTTP API already has a PaginatorInterface and needs stable prev / next URLs and a serializable pagination envelope.
Boundary
This package does not calculate pagination itself and does not query storage. Page math and PaginatorInterface are provided by componenta/paginator. This package only adapts that paginator to HTTP URLs and array responses.
Installation
Dependencies
| Package | Purpose |
|---|---|
componenta/paginator |
Provides PaginatorInterface and pagination metadata. |
componenta/arrayable |
Provides the Arrayable contract used by ResourcePaginator. |
psr/http-message |
Provides PSR-7 request and URI interfaces. |
Main API
PaginatorUrlBuilder builds page URLs while preserving the current query string:
PaginatorUrlBuilder::fromRequest() uses the request URI and the default parameter names offset and limit. The constructor allows custom parameter names:
ResourcePaginator wraps a paginator and generated links into an arrayable structure for API responses:
The default output fields are count, prev, next, range, page, and results. Pass a field list to the constructor to limit the output:
Unknown field names are included with null values because ResourcePaginator preserves the requested field list.
Errors
PaginatorUrlBuilder throws InvalidArgumentException when the offset or limit parameter name is empty, or when both parameter names are the same. Page and limit values passed to pageUrl() are normalized to at least 1.
Related Packages
componenta/paginatorprovides the paginator value object.componenta/arrayableprovides theArrayablecontract.
All versions of http-pagination with dependencies
componenta/arrayable Version ^1.0
componenta/paginator Version ^1.0
psr/http-message Version ^2.0