Symfony Profiler

<?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\Hydra\Serializer;
use ApiPlatform\Api\FilterInterface;
use ApiPlatform\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Api\FilterCollection;
use ApiPlatform\Core\Api\FilterLocatorTrait;
use ApiPlatform\Core\Api\ResourceClassResolverInterface as LegacyResourceClassResolverInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use Psr\Container\ContainerInterface;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
/**
* Enhances the result of collection by adding the filters applied on collection.
*
* @author Samuel ROZE <samuel.roze@gmail.com>
*/
final class CollectionFiltersNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
{
use FilterLocatorTrait;
private $collectionNormalizer;
private $resourceMetadataFactory;
private $resourceClassResolver;
/**
* @param ContainerInterface|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
* @param mixed $resourceMetadataFactory
* @param ResourceClassResolverInterface|LegacyResourceClassResolverInterface $resourceClassResolver
*/
public function __construct(NormalizerInterface $collectionNormalizer, $resourceMetadataFactory, $resourceClassResolver, $filterLocator)
{
$this->setFilterLocator($filterLocator);
$this->collectionNormalizer = $collectionNormalizer;
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->resourceClassResolver = $resourceClassResolver;
if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
}
}
/**
* {@inheritdoc}
*/
public function supportsNormalization($data, $format = null, array $context = []): bool
{
return $this->collectionNormalizer->supportsNormalization($data, $format, $context);
}
/**
* {@inheritdoc}
*/
public function hasCacheableSupportsMethod(): bool
{
return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
}
/**
* {@inheritdoc}
*
* @return array|string|int|float|bool|\ArrayObject|null
*/
public function normalize($object, $format = null, array $context = [])
{
$data = $this->collectionNormalizer->normalize($object, $format, $context);
if (!\is_array($data)) {
throw new UnexpectedValueException('Expected data to be an array');
}
if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
return $data;
}
$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
$resourceFilters = null;
if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
$operationName = $context['collection_operation_name'] ?? null;
if (null === $operationName) {
$resourceFilters = $resourceMetadata->getAttribute('filters', []);
} else {
$resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);
}
} elseif ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
$operation = $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation($context['operation_name'] ?? null);
$resourceFilters = $operation->getFilters();
}
if (!$resourceFilters) {
return $data;
}
$requestParts = parse_url($context['request_uri'] ?? '');
if (!\is_array($requestParts)) {
return $data;
}
$currentFilters = [];
foreach ($resourceFilters as $filterId) {
if ($filter = $this->getFilter($filterId)) {
$currentFilters[] = $filter;
}
}
if ($currentFilters) {
$data['hydra:search'] = $this->getSearch($resourceClass, $requestParts, $currentFilters);
}
return $data;
}
/**
* {@inheritdoc}
*/
public function setNormalizer(NormalizerInterface $normalizer)
{
if ($this->collectionNormalizer instanceof NormalizerAwareInterface) {
$this->collectionNormalizer->setNormalizer($normalizer);
}
}
/**
* Returns the content of the Hydra search property.
*
* @param FilterInterface[] $filters
*/
private function getSearch(string $resourceClass, array $parts, array $filters): array
{
$variables = [];
$mapping = [];
foreach ($filters as $filter) {
foreach ($filter->getDescription($resourceClass) as $variable => $data) {
$variables[] = $variable;
$mapping[] = ['@type' => 'IriTemplateMapping', 'variable' => $variable, 'property' => $data['property'], 'required' => $data['required']];
}
}
return ['@type' => 'hydra:IriTemplate', 'hydra:template' => sprintf('%s{?%s}', $parts['path'], implode(',', $variables)), 'hydra:variableRepresentation' => 'BasicRepresentation', 'hydra:mapping' => $mapping];
}
}
class_alias(CollectionFiltersNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\CollectionFiltersNormalizer::class);

vendor/api-platform/core/src/Hydra/Serializer/CollectionFiltersNormalizer.php line 53