Skip to content
Snippets Groups Projects
Commit ae687fd4 authored by Tobias Gross-Vogt's avatar Tobias Gross-Vogt
Browse files

using data provider from core; new pagination handling -> new provider... 

using data provider from core; new pagination handling -> new provider interface --> BREAKING CHANGE
parent 31d2e7e1
No related branches found
No related tags found
No related merge requests found
Pipeline #204612 passed
Stage: test
Hide whitespace changes
Inline Side-by-side
composer.lock
+ 4
− 4
View file @ ae687fd4
......@@ -169,11 +169,11 @@
},
{
"name": "dbp/relay-core-bundle",
"version": "v0.1.55",
"version": "v0.1.56",
"source": {
"type": "git",
"url": "https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle",
"reference": "b1d1eaa5e9efc58a09e6176215c243041df168f3"
"reference": "0183be15e0c582d935420fb558ea293ab6af1b8b"
},
"require": {
"api-platform/core": "^2.6.8 <2.7.0",
......@@ -237,7 +237,7 @@
"AGPL-3.0-or-later"
],
"description": "The core bundle of the Relay API gateway",
"time": "2022-11-10T10:15:38+00:00"
"time": "2022-11-15T08:43:56+00:00"
},
{
"name": "doctrine/annotations",
......@@ -10043,5 +10043,5 @@
"platform-overrides": {
"php": "7.3"
},
"plugin-api-version": "2.3.0"
"plugin-api-version": "2.2.0"
}
src/API/OrganizationProviderInterface.php
+ 9
− 8
View file @ ae687fd4
......@@ -6,13 +6,12 @@ namespace Dbp\Relay\BaseOrganizationBundle\API;
use Dbp\Relay\BaseOrganizationBundle\Entity\Organization;
use Dbp\Relay\CoreBundle\Exception\ApiError;
use Dbp\Relay\CoreBundle\Pagination\Paginator;
interface OrganizationProviderInterface
{
/**
* @param array $options Available options:
* * 'lang' ('de' or 'en')
* * Locale::LANGUAGE_OPTION (language in ISO 639‑1 format)
* * LocalData::INCLUDE_PARAMETER_NAME
*
* @throws ApiError
......@@ -21,13 +20,15 @@ interface OrganizationProviderInterface
/**
* @param array $options Available options:
* * string 'lang' ('de' or 'en')
* * array 'identifiers' The list of organizations to return
* * string Organization::SEARCH_PARAMETER_NAME (partial, case-insensitive text search on 'name' attribute)
* * string LocalData::INCLUDE_PARAMETER_NAME
* * string LocalData::QUERY_PARAMETER_NAME
* * Locale::LANGUAGE_OPTION (language in ISO 639‑1 format)
* * 'identifiers' The list of organizations to return
* * Organization::SEARCH_PARAMETER_NAME (partial, case-insensitive text search on 'name' attribute)
* * LocalData::INCLUDE_PARAMETER_NAME
* * LocalData::QUERY_PARAMETER_NAME
*
* @return Organization[]
*
* @throws ApiError
*/
public function getOrganizations(array $options = []): Paginator;
public function getOrganizations(int $currentPageNumber, int $maxNumItemsPerPage, array $options = []): array;
}
src/DataProvider/OrganizationCollectionDataProvider.php → src/DataProvider/OrganizationDataProvider.php
+ 90
− 0
View file @ ae687fd4
......@@ -4,70 +4,58 @@ declare(strict_types=1);
namespace Dbp\Relay\BaseOrganizationBundle\DataProvider;
use ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
use ApiPlatform\Core\DataProvider\PaginatorInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use Dbp\Relay\BaseOrganizationBundle\API\OrganizationProviderInterface;
use Dbp\Relay\BaseOrganizationBundle\API\OrganizationsByPersonProviderInterface;
use Dbp\Relay\BaseOrganizationBundle\Entity\Organization;
use Dbp\Relay\CoreBundle\DataProvider\AbstractDataProvider;
use Dbp\Relay\CoreBundle\Exception\ApiError;
use Dbp\Relay\CoreBundle\Helpers\Locale;
use Dbp\Relay\CoreBundle\LocalData\LocalData;
use Dbp\Relay\CoreBundle\Pagination\Pagination;
use Dbp\Relay\CoreBundle\Pagination\Paginator;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Dbp\Relay\CoreBundle\Locale\Locale;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Response;
final class OrganizationCollectionDataProvider extends AbstractController implements ContextAwareCollectionDataProviderInterface, RestrictedDataProviderInterface
class OrganizationDataProvider extends AbstractDataProvider
{
public const MAX_ITEMS_PER_PAGE = 250;
/** @var OrganizationProviderInterface */
private $organizationProvider;
/** @var OrganizationsByPersonProviderInterface */
private $organizationsByPersonProvider;
/** @var Locale */
private $locale;
/** @var RequestStack */
private $requestStack;
public function __construct(OrganizationProviderInterface $organizationProvider, Locale $locale, OrganizationsByPersonProviderInterface $organizationsByPersonProvider)
public function __construct(OrganizationProviderInterface $organizationProvider, OrganizationsByPersonProviderInterface $organizationsByPersonProvider, RequestStack $requestStack)
{
$this->organizationProvider = $organizationProvider;
$this->locale = $locale;
$this->organizationsByPersonProvider = $organizationsByPersonProvider;
$this->requestStack = $requestStack;
}
public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
protected function getResourceClass(): string
{
return Organization::class === $resourceClass;
return Organization::class;
}
public function getCollection(string $resourceClass, string $operationName = null, array $context = []): Paginator
protected function getItemById($id, array $options = []): object
{
$this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY');
$filters = $context['filters'] ?? [];
$options = [];
if ($search = ($filters['search'] ?? null)) {
$options['search'] = $search;
}
LocalData::addOptions($options, $filters);
//-------------------------------------------------------------------------
// @deprecate 'lang' query parameter is deprecate, use 'Accept-Language' header instead
$queryParameters = $this->requestStack->getCurrentRequest()->query->all();
$this->tryAddDeprecatedLangQueryParameter($options, $queryParameters);
//-------------------------------------------------------------------------
$filters['partialPagination'] = true;
Pagination::addOptions($options, $filters, self::MAX_ITEMS_PER_PAGE);
return $this->organizationProvider->getOrganizationById($id, $options);
}
// @deprecate 'lang' filter is deprecate, use 'Accept-Language' header instead
if (($lang = $filters['lang'] ?? null) !== null) {
$options[Locale::LANGUAGE_OPTION] = $lang;
} else {
$this->locale->addLanguageOption($options);
}
protected function getPage(int $currentPageNumber, int $maxNumItemsPerPage, array $filters = [], array $options = []): array
{
//-------------------------------------------------------------------------
// @deprecate 'lang' query parameter is deprecate, use 'Accept-Language' header instead
$this->tryAddDeprecatedLangQueryParameter($options, $filters);
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
// @deprecate The 'person' filter is deprecate. Use the 'identifiers' filter in your custom organizations wrapper.
// @deprecate The 'person' filter is deprecate. Use the 'identifiers' filter in your custom organization wrapper.
$personId = $filters['person'] ?? '';
if ($personId !== '') {
if ($personId !== $this->getUser()->getUserIdentifier()) {
......@@ -75,19 +63,28 @@ final class OrganizationCollectionDataProvider extends AbstractController implem
}
$organizations = [];
$orgIdPaginator = $this->organizationsByPersonProvider->getOrganizationsByPerson($personId, $options);
foreach ($orgIdPaginator as $organizationId) {
foreach ($this->organizationsByPersonProvider->getOrganizationsByPerson($personId, $options) as $organizationId) {
$organizations[] = $this->organizationProvider->getOrganizationById($organizationId, $options);
}
if ($orgIdPaginator instanceof PaginatorInterface) {
return Pagination::createFullPaginator($organizations, $options, intval($orgIdPaginator->getTotalItems()));
} else {
return Pagination::createPartialPaginator($organizations, $options);
}
return $organizations;
}
//-------------------------------------------------------------------------
return $this->organizationProvider->getOrganizations($options);
if ($search = ($filters['search'] ?? null)) {
$options['search'] = $search;
}
return $this->organizationProvider->getOrganizations($currentPageNumber, $maxNumItemsPerPage, $options);
}
/**
* @deprecate 'lang' query parameter is deprecated, use 'Accept-Language' header instead
*/
private function tryAddDeprecatedLangQueryParameter(array &$targetOptions, array $filters)
{
if (($lang = $filters['lang'] ?? null) !== null) {
$targetOptions[Locale::LANGUAGE_OPTION] = $lang;
}
}
}
src/DataProvider/OrganizationItemDataProvider.php deleted 100644 → 0
+ 0
− 52
View file @ 31d2e7e1
<?php
declare(strict_types=1);
namespace Dbp\Relay\BaseOrganizationBundle\DataProvider;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use Dbp\Relay\BaseOrganizationBundle\API\OrganizationProviderInterface;
use Dbp\Relay\BaseOrganizationBundle\Entity\Organization;
use Dbp\Relay\CoreBundle\Helpers\Locale;
use Dbp\Relay\CoreBundle\LocalData\LocalData;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
final class OrganizationItemDataProvider extends AbstractController implements ItemDataProviderInterface, RestrictedDataProviderInterface
{
/** @var OrganizationProviderInterface */
private $api;
/** @var Locale */
private $locale;
public function __construct(OrganizationProviderInterface $api, Locale $locale)
{
$this->api = $api;
$this->locale = $locale;
}
public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
{
return Organization::class === $resourceClass;
}
public function getItem(string $resourceClass, $id, string $operationName = null, array $context = []): ?Organization
{
$this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY');
$filters = $context['filters'] ?? [];
$options = [];
LocalData::addOptions($options, $filters);
// @deprecate 'lang' filter is deprecate, use 'Accept-Language' header instead
if (($lang = $filters['lang'] ?? null) !== null) {
$options[Locale::LANGUAGE_OPTION] = $lang;
} else {
$this->locale->addLanguageOption($options);
}
return $this->api->getOrganizationById($id, $options);
}
}
src/Resources/config/services.yaml
+ 1
− 2
View file @ ae687fd4
services:
Dbp\Relay\BaseOrganizationBundle\DataProvider\:
resource: '../../DataProvider'
Dbp\Relay\BaseOrganizationBundle\DataProvider\OrganizationDataProvider:
autowire: true
autoconfigure: true
......
src/Service/DummyOrganizationProvider.php
+ 2
− 4
View file @ ae687fd4
......@@ -6,8 +6,6 @@ namespace Dbp\Relay\BaseOrganizationBundle\Service;
use Dbp\Relay\BaseOrganizationBundle\API\OrganizationProviderInterface;
use Dbp\Relay\BaseOrganizationBundle\Entity\Organization;
use Dbp\Relay\CoreBundle\Pagination\Paginator;
use Dbp\Relay\CoreBundle\Pagination\WholeResultPaginator;
class DummyOrganizationProvider implements OrganizationProviderInterface
{
......@@ -20,8 +18,8 @@ class DummyOrganizationProvider implements OrganizationProviderInterface
return $org;
}
public function getOrganizations(array $options = []): Paginator
public function getOrganizations(int $currentPageNumber, int $maxNumItemsPerPage, array $options = []): array
{
return new WholeResultPaginator([$this->getOrganizationById('foo', $options)], 1, 30);
return [$this->getOrganizationById('foo', $options)];
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment