Download the PHP package jeffersonsimaogoncalves/cakephp-api-pagination without Composer
On this page you can find all versions of the php package jeffersonsimaogoncalves/cakephp-api-pagination. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jeffersonsimaogoncalves/cakephp-api-pagination
More information about jeffersonsimaogoncalves/cakephp-api-pagination
Files in jeffersonsimaogoncalves/cakephp-api-pagination
Package cakephp-api-pagination
Short Description CakePHP 3 plugin that injects pagination information into API responses.
License MIT
Homepage https://github.com/jeffersonsimaogoncalves/cakephp-api-pagination
Informations about the package cakephp-api-pagination
CakePHP API Pagination
This is a simple component for CakePHP 3 which injects pagination information from CakePHP's Paginator into serialized JsonView and XmlView responses.
Install
Via Composer
Load the plugin in your application's bootstrap.php
file:
Usage
Make sure your application has been set up to use data views; see the Enabling Data Views in Your Application section of the CakePHP documentation.
Then, load ApiPaginationComponent
:
Then, go ahead and set your paginated view variable like so:
Note: It is important that your _serialize
variable is an array, e.g.
['articles']
, so that your pagination information can be set under its own
pagination key.
Your JsonView and XmlView responses will now contain the pagination information, and will look something like this:
Configuring the Pagination Output
ApiPagination has three keys for configuration: key
, aliases
, and visible
.
-
key
allows you to change the name of the pagination key. -
aliases
allows you to change names of the pagination detail keys. visible
allows you to set which pagination keys will be exposed in the response. Note: Whenever setting a key's visibility, make sure to use the aliased name if you've given it one.
An example using all these configuration keys:
This configuration would yield:
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Bryan Crowe
- All Contributors
License
The MIT License (MIT). Please see License File for more information.