| Current File : //var/www/vinorea/vendor/api-platform/core/src/JsonApi/Serializer/CollectionNormalizer.php |
<?php
/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace ApiPlatform\JsonApi\Serializer;
use ApiPlatform\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\Serializer\AbstractCollectionNormalizer;
use ApiPlatform\Util\IriHelper;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
/**
* Normalizes collections in the JSON API format.
*
* @author Kevin Dunglas <dunglas@gmail.com>
* @author Hamza Amrouche <hamza@les-tilleuls.coop>
* @author Baptiste Meyer <baptiste.meyer@gmail.com>
*/
final class CollectionNormalizer extends AbstractCollectionNormalizer
{
public const FORMAT = 'jsonapi';
public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, $resourceMetadataFactory)
{
parent::__construct($resourceClassResolver, $pageParameterName, $resourceMetadataFactory);
}
/**
* {@inheritdoc}
*/
protected function getPaginationData($object, array $context = []): array
{
[$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
$parsed = IriHelper::parseIri($context['uri'] ?? '/', $this->pageParameterName);
/** @var ResourceMetadata|ResourceMetadataCollection */
$metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? '');
if ($metadata instanceof ResourceMetadataCollection) {
$operation = $metadata->getOperation($context['operation_name'] ?? null);
$urlGenerationStrategy = $operation->getUrlGenerationStrategy();
} else {
$urlGenerationStrategy = $metadata->getAttribute('url_generation_strategy');
}
$data = [
'links' => [
'self' => IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null, $urlGenerationStrategy),
],
];
if ($paginated) {
if (null !== $lastPage) {
$data['links']['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1., $urlGenerationStrategy);
$data['links']['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage, $urlGenerationStrategy);
}
if (1. !== $currentPage) {
$data['links']['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1., $urlGenerationStrategy);
}
if (null !== $lastPage && $currentPage !== $lastPage || null === $lastPage && $pageTotalItems >= $itemsPerPage) {
$data['links']['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1., $urlGenerationStrategy);
}
}
if (null !== $totalItems) {
$data['meta']['totalItems'] = $totalItems;
}
if ($paginator) {
$data['meta']['itemsPerPage'] = (int) $itemsPerPage;
$data['meta']['currentPage'] = (int) $currentPage;
}
return $data;
}
/**
* {@inheritdoc}
*
* @throws UnexpectedValueException
*/
protected function getItemsData($object, string $format = null, array $context = []): array
{
$data = [
'data' => [],
];
foreach ($object as $obj) {
$item = $this->normalizer->normalize($obj, $format, $context);
if (!\is_array($item)) {
throw new UnexpectedValueException('Expected item to be an array');
}
if (!isset($item['data'])) {
throw new UnexpectedValueException('The JSON API document must contain a "data" key.');
}
$data['data'][] = $item['data'];
if (isset($item['included'])) {
$data['included'] = array_values(array_unique(array_merge($data['included'] ?? [], $item['included']), \SORT_REGULAR));
}
}
return $data;
}
}
class_alias(CollectionNormalizer::class, \ApiPlatform\Core\JsonApi\Serializer\CollectionNormalizer::class);