Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aratinau/api-platform-pagination

Examples using Api-Platform on custom data with filter, sort and pagination using DataProvider
https://github.com/aratinau/api-platform-pagination

api-platform php symfony

Last synced: about 2 months ago
JSON representation

Examples using Api-Platform on custom data with filter, sort and pagination using DataProvider

Awesome Lists containing this project

README 

        
# Api Platform Sort, Filter and Pagination on custom data



Inspired by https://github.com/api-platform/demo



# Summary



- [First Example use raw data from a csv file](#first-example-use-raw-data-from-a-csv-file)

- [Second example use custom controller](#second-example-use-custom-controller)

- [Third example use MovieCollectionDataProvider and repository](#third-example-use-moviecollectiondataprovider-and-repository)

- [Fourth example use QueryBuilder in CarCollectionDataProvider (collectionExtensions)](#fourth-example-use-querybuilder-in-carcollectiondataprovider-collectionextensions)

- [Fifth example use JobCollectionDataProvider (paginationExtension)](#fifth-example-use-jobcollectiondataprovider-paginationextension)

- [Sixth example use FurnitureDataProvider (collectionDataProvider)](#sixth-example-use-furnituredataprovider-collectiondataprovider)

- [Seventh example use QueryBuilder in subresource](#seventh-example--simple-dataprovider-using-subresourcedataprovider)

- [Eighth example use QueryBuilder in subresource](#eighth-example-use-querybuilder-in-subresource)

- [Ninth use custom subresource with provider (without subresourceDataProvider)](#ninth-example---custom-subresource-with-provider-without-subresourcedataprovider)

- [Tenth example - Custom Paginator in Provider with QueryBuilder](#tenth-example---custom-paginator-in-provider-with-querybuilder)

- [🚀How to create a Collection Data Provider and keep Doctrine Extension, Filters and Pagination on it](#how-to-create-a-collection-data-provider-and-keep-doctrine-extension-filters-and-pagination-on-it)



## Install



Build the project `make build`



Start the project `make start`



Enter the php container with `make sh`



Install dependencies (in php container) with `composer install`



Load fixtures with `make init-fixtures`



You can go to `http://127.0.0.1:8000/api/`



## First Example use raw data from a csv file



Example using a custom `CityFilter` filtering on raw data from the file `Repository/City/data/worldcities.csv`



CityFilter pass the `sort` and `order` params to the context and this context it's processed in the `CityCollectionDataProvider`



The pagination is available



### Usage



sort and filter on raw data from csv

`/api/cities?search[key]=tokyo&order[key]=desc&page=1`



#### Keys available



- id

- city

- city_ascii

- lat

- lng

- country

- iso2

- iso3

- admin_name

- capital

- population



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/f40232ed62d2720fa3140f6ce6cc89c36798dd6a

- https://github.com/aratinau/api-platform-pagination/commit/1d34f49c1520040a88c63b3f1d391ad3d24e8248



## Second example use custom controller



On path `/movies/custom-action` the action `CustomMovieAction` is called and page and order use `getCustom` method from `MovieRepository`.

The pagination is available



### Usage



custom controller action from database using Paginator

`api/movies/custom-action?page=1&order[id]=asc&order[title]=desc`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/ea7db84cb60b1a6ad141894849e8f9ad5b982e84



## Third example use MovieCollectionDataProvider and repository



On the normalization_context group `normalization-custom-action-using-dataprovider` the MovieCollectionDataProvider is called and the resust is from the repository. The param `isPublished=true|false` can be used and the result is filtered by the value asked.

The param `order` can be `title` or `id` and ordered by `asc|desc`. The pagination is available



### Usage



data provider using repository (by group from normalization_context on Movie entity)

`api/movies/custom-action-using-dataprovider?page=2&order[title]=desc&isPublished=false`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/c33a7940a367152b9457607e11c5e65970aceb9b

- https://github.com/aratinau/api-platform-pagination/commit/861cfc9267958825640ff549befb29f386b0a252



## Fourth example use QueryBuilder in CarCollectionDataProvider (collectionExtensions)



This example show how use QueryBuilder and filters with CollectionExtensions in CarCollectionDataProvider.

The collection is filtered by color from the `context` with the QueryBuilder and filtered by `name` and `isPublished` from SearchFilter in Car entity.

The pagination is available



### Usage



`/api/cars?color=color_name&isPublished=true|false&page=1`



#### Color name available



- red

- orange

- green

- yellow

- black



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/4d8d22a4ccad265b7de1bffc15729df06eb5ded4



## Fifth example use JobCollectionDataProvider (paginationExtension)



This example show how use PaginationExtension in JobCollectionDataProvider



### Usage



`api/jobs?page=1`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/53ce8298d7c28e17fc0a55c5c78ecb0ce2fc9a1d



## Sixth example use FurnitureDataProvider (collectionDataProvider)



Basic example showing how use and configure CollectionDataProvider



### Usage



`api/furniture?page=2`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/2cab86c65dd40ba218bca175f217581e94660b7b



## Seventh example : simple DataProvider using subresourceDataProvider



CommentSubresourceDataProvider show how use the standard behaviour



### Usage



`api/movies/{id}/comments`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/6addf42683e8278b8f81afadc11d269a81a17f9e



## Eighth example use QueryBuilder in subresource



DiscussionSubresourceDataProvider show how use QueryBuilder and order by DESC the result



### Usage



`api/discussions/{id}/messages?page=1`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/29ac71e2f98024439a8cffc81287a41ec0afe4a3



## Ninth example - custom subresource with provider (without subresourceDataProvider)



With JobDataProvider and path `jobs/{id}/employees` return employees from id's job



[ ] TODO Pagination



### Usage



`api/jobs/{id}/employees/{arg1}`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/5be041c859ce58e0ccc894fe1efd0ed7855b6dc4



## Tenth example - Custom Paginator in Provider with QueryBuilder



PostCollectionDataProvider call the method findLatest from PostRepository and PostRepository call PostPaginator



### Usage



`/api/posts?page=2`



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/9a0989e3cab1ef7faceeabc3217098a54c75906d



## Notes



`Album` and `Artist` are ready to be used



## How to create a Collection Data Provider and keep Doctrine Extension, Filters and Pagination on it



We're going to create a Provider who will return only books not archived when the param `includeArchived` is missing. 

It will return the books by the locale corresponding in a Doctrine Extension



### Usage

`/api/books` or `/api/books?includeArchived=false` return only books not archived



`/api/books?includeArchived=true` return all books (archived or not)



### Quick explanation



In our `BookCollectionDataProvider` we have this condition:



```php

$includeArchived = $context['filters']['includeArchived'] ?? 'false';

// ...

if ($includeArchived === 'false') {

    $queryBuilder->andWhere("$alias.isArchived = false");

}

```



Then we create a `BookExtension` and add this condition to return book by locale defined.



```php

->andWhere("$rootAlias.locale = :locale")

->setParameter('locale', self::LOCALE)

```



Then in `BookCollectionDataProvider` we can loop over all the extensions on `$collectionExtensions` (we defined $collectionExtensions on `services.yaml`) so it apply to all extensions.



Extensions called are (in this order): 



- `"App\Doctrine\BookExtension"`

- `"ApiPlatform\Doctrine\Orm\Extension\FilterExtension"`

- `"ApiPlatform\Doctrine\Orm\Extension\FilterEagerLoadingExtension"`

- `"ApiPlatform\Doctrine\Orm\Extension\EagerLoadingExtension"`

- `"ApiPlatform\Doctrine\Orm\Extension\OrderExtension"`

- `"ApiPlatform\Doctrine\Orm\Extension\PaginationExtension"`



Now you can still use the `SortOrder` on the `Book` entity for example, and add the param `isArchived` and the result will be pass through the DoctrineExtension to set the locale.



###### Commits related



- https://github.com/aratinau/api-platform-pagination/commit/1d27f16adecda1c0956fcc5d0da81f017d915c1b