Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mixerapi/collection-view
A CakePHP Collection View for displaying configurable pagination meta data in JSON or XML collection responses. [READ-ONLY]
https://github.com/mixerapi/collection-view
cakephp collections json pagination serialization xml
Last synced: 2 months ago
JSON representation
A CakePHP Collection View for displaying configurable pagination meta data in JSON or XML collection responses. [READ-ONLY]
- Host: GitHub
- URL: https://github.com/mixerapi/collection-view
- Owner: mixerapi
- License: other
- Created: 2020-09-19T16:17:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T23:50:23.000Z (9 months ago)
- Last Synced: 2024-04-26T11:22:30.610Z (8 months ago)
- Topics: cakephp, collections, json, pagination, serialization, xml
- Language: PHP
- Homepage: https://mixerapi.com/plugins/collection-view
- Size: 64.5 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MixerAPI CollectionView
[](https://packagist.org/packages/mixerapi/collection-view)
[](https://github.com/mixerapi/mixerapi-dev/actions?query=workflow%3ABuild)
[](https://coveralls.io/github/mixerapi/mixerapi-dev?branch=master)
[](https://mixerapi.com)
[](https://book.cakephp.org/4/en/index.html)
[](https://php.net/)
A simple Collection View for displaying configurable pagination meta data in JSON or XML collection responses. Read
more at [MixerAPI.com](https://mixerapi.com).
## Installation
!!! info ""
You can skip this step if MixerAPI is installed. However, you will still new to define your viewClasses (read below).
```console
composer require mixerapi/collection-view
bin/cake plugin load MixerApi/CollectionView
```
Alternatively after composer installing you can manually load the plugin in your Application:
```php
# src/Application.php
public function bootstrap(): void
{
// other logic...
$this->addPlugin('MixerApi/CollectionView');
}
```
## Setup
Your controllers must define their
[view classes for content negotiation](https://book.cakephp.org/5/en/views/json-and-xml-views.html#defining-view-classes-to-negotiate-with).
```php
use MixerApi\CollectionView\View\JsonCollectionView;
use MixerApi\CollectionView\View\XmlCollectionView;
public function viewClasses(): array
{
return [JsonCollectionView::class, XmlCollectionView::class];
}
```
This can be done in your AppController to add them to all inheriting controllers or on a controller-by-controller basis.
## Usage
That's it, you're done. Perform `application/xml` or `application/json` requests as normal. You may also request by
`.xml` or `.json` extensions (assuming you've enabled them in your `config/routes.php`). This plugin will only modify
collections (e.g. controller::index action) requests, not item (e.g. controller::view action) requests.
JSON sample
```json
{
"collection": {
"url": "/films?page=3&direction=desc",
"count": 20,
"total": 1000,
"pages": 50,
"next": "/films?page=4",
"prev": "/films?page=2",
"first": "/films",
"last": "/films?page=50"
},
"data": [
{
"id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS",
"modified": "2006-02-15T04:34:33+00:00",
"films": [
{
"id": 1,
"title": "ACADEMY DINOSAUR",
"description": "A Epic Drama of a Feminist And a Mad Scientist who must Battle a Teacher in The Canadian Rockies",
"release_year": "2006",
"language_id": 1,
"rental_duration": 6,
"length": 86,
"rating": "PG",
"special_features": "Deleted Scenes,Behind the Scenes",
"modified": "2006-02-15T05:03:42+00:00"
}
]
}
]
}
```
XML sample
```xml
/films?page=3&direction=desc
20
1000
50
/films?page=4
/films?page=2
/films
/films?page=50
1
PENELOPE
GUINESS
2/15/06, 4:34 AM
1
ACADEMY DINOSAUR
A Epic Drama of a Feminist And a Mad Scientist who must Battle a Teacher in The Canadian Rockies
2006
1
6
86
PG
Deleted Scenes,Behind the Scenes
2/15/06, 5:03 AM
```
## Configuration
This is optional. You can alter the names of the response keys, simply create a config/collection_view.php file. Using
the example below we can change the `collection` key to `pagination`, `data` to `items`, and alter some key names within
our new pagination object. Just keep the mapped items `{{names}}` as-is.
```php
# config/collection_view.php
return [
'CollectionView' => [
'pagination' => '{{collection}}', // array that holds pagination data
'pagination.url' => '{{url}}', // url of current page
'pagination.count' => '{{count}}', // items on the page
'pagination.total' => '{{total}}', // total database records
'pagination.pages' => '{{pages}}', // total pages
'pagination.next' => '{{next}}', // next page url
'pagination.prev' => '{{prev}}', // previous page url
'pagination.first' => '{{first}}', // first page url
'pagination.last' => '{{last}}', // last page url
'items' => '{{data}}', // the collection of data
]
];
```