20847864477

Committed 09 Jan 2026 09:47AM UTC coverage: 29.1% (+0.005%) from 29.095%

Build # 20847864477

Build Type

Pull #7649

github

Committed by

web-flow

Commit Message

Merge b342dd5db into d640d106b

Pull Request Pull Request #7649: feat(validator): uuid/ulid parameter validation

Run Details

0 of 4 new or added lines in 1 file covered. (0.0%)

15050 existing lines in 491 files now uncovered.

16996 of 58406 relevant lines covered (29.1%)

81.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.0

/src/Serializer/AbstractCollectionNormalizer.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\Serializer;

use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\State\Pagination\PaginatorInterface;
use ApiPlatform\State\Pagination\PartialPaginatorInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Serializer;

/**
 * Base collection normalizer.
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
abstract class AbstractCollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface
{
    use ContextTrait {
        initContext as protected;
    }
    use NormalizerAwareTrait;
    use OperationContextTrait;

    /**
     * This constant must be overridden in the child class.
     */
    public const FORMAT = 'to-override';

    public function __construct(protected ResourceClassResolverInterface $resourceClassResolver, protected string $pageParameterName, protected ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null)
    {
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
    {
        return static::FORMAT === $format && is_iterable($data);
    }

    /**
     * {@inheritdoc}
     */
    public function getSupportedTypes(?string $format): array
    {
        /*
         * At this point, support anything that is_iterable(), i.e. array|Traversable
         * for non-objects, symfony uses 'native-'.\gettype($data) :
         * https://github.com/tucksaun/symfony/blob/400685a68b00b0932f8ef41096578872b643099c/src/Symfony/Component/Serializer/Serializer.php#L254
         */
        if (static::FORMAT === $format) {
            return [
                'native-array' => true,
                '\Traversable' => true,
            ];
        }

        return [];
    }

    /**
     * {@inheritdoc}
     *
     * @param iterable $data
     */
    public function normalize(mixed $data, ?string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
    {
        if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
            return $this->normalizeRawCollection($data, $format, $context);
        }

        $resourceClass = $this->resourceClassResolver->getResourceClass($data, $context['resource_class']);
        $collectionContext = $this->initContext($resourceClass, $context);
        $normalizedData = [];
        $paginationData = $this->getPaginationData($data, $collectionContext);

        $childContext = $this->createOperationContext($collectionContext, $resourceClass);
        if (isset($collectionContext['force_resource_class'])) {
            $childContext['force_resource_class'] = $collectionContext['force_resource_class'];
        }

        $itemsData = $this->getItemsData($data, $format, $childContext);

        return array_merge_recursive($normalizedData, $paginationData, $itemsData);
    }

    /**
     * Normalizes a raw collection (not API resources).
     */
    protected function normalizeRawCollection(iterable $object, ?string $format = null, array $context = []): array|\ArrayObject
    {
        if ([] === $object && ($context[Serializer::EMPTY_ARRAY_AS_OBJECT] ?? false)) {
            return new \ArrayObject();
        }

        $data = [];
        foreach ($object as $index => $obj) {
            $data[$index] = $this->normalizer->normalize($obj, $format, $context);
        }

        return $data;
    }

    /**
     * Gets the pagination configuration.
     */
    protected function getPaginationConfig(iterable $object, array $context = []): array
    {
        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = $totalItems = null;
        $paginated = $paginator = false;

        if ($object instanceof PartialPaginatorInterface) {
            $paginated = $paginator = true;
            if ($object instanceof PaginatorInterface) {
                $paginated = 1. !== $lastPage = $object->getLastPage();
                $totalItems = $object->getTotalItems();
            } else {
                $pageTotalItems = (float) \count($object);
            }

            $currentPage = $object->getCurrentPage();
            $itemsPerPage = $object->getItemsPerPage();
        } elseif (is_countable($object)) {
            $totalItems = \count($object);
        }

        return [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems];
    }

    protected function getOperation(array $context = []): Operation
    {
        $metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? '');

        return $metadata->getOperation($context['operation_name'] ?? null);
    }

    /**
     * Gets the pagination data.
     */
    abstract protected function getPaginationData(iterable $object, array $context = []): array;

    /**
     * Gets items data.
     */
    abstract protected function getItemsData(iterable $object, ?string $format = null, array $context = []): array;
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Serializer;
15
16	use ApiPlatform\Metadata\Operation;
17	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
18	use ApiPlatform\Metadata\ResourceClassResolverInterface;
19	use ApiPlatform\State\Pagination\PaginatorInterface;
20	use ApiPlatform\State\Pagination\PartialPaginatorInterface;
21	use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
22	use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
23	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
24	use Symfony\Component\Serializer\Serializer;
25
26	/**
27	* Base collection normalizer.
28	*
29	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
30	*/
31	abstract class AbstractCollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface
32	{
33	use ContextTrait {
34	initContext as protected;
35	}
36	use NormalizerAwareTrait;
37	use OperationContextTrait;
38
39	/**
40	* This constant must be overridden in the child class.
41	*/
42	public const FORMAT = 'to-override';
43
44	public function __construct(protected ResourceClassResolverInterface $resourceClassResolver, protected string $pageParameterName, protected ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null)
45	{
UNCOV 46	}	2,409✔
47
48	/**
49	* {@inheritdoc}
50	*/
51	public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
52	{
UNCOV 53	return static::FORMAT === $format && is_iterable($data);	1,304✔
54	}
55
56	/**
57	* {@inheritdoc}
58	*/
59	public function getSupportedTypes(?string $format): array
60	{
61	/*
62	* At this point, support anything that is_iterable(), i.e. array\|Traversable
63	* for non-objects, symfony uses 'native-'.\gettype($data) :
64	* https://github.com/tucksaun/symfony/blob/400685a68b00b0932f8ef41096578872b643099c/src/Symfony/Component/Serializer/Serializer.php#L254
65	*/
UNCOV 66	if (static::FORMAT === $format) {	2,086✔
UNCOV 67	return [	1,711✔
UNCOV 68	'native-array' => true,	1,711✔
UNCOV 69	'\Traversable' => true,	1,711✔
UNCOV 70	];	1,711✔
71	}
72
UNCOV 73	return [];	2,078✔
74	}
75
76	/**
77	* {@inheritdoc}
78	*
79	* @param iterable $data
80	*/
81	public function normalize(mixed $data, ?string $format = null, array $context = []): array\|string\|int\|float\|bool\|\ArrayObject\|null
82	{
UNCOV 83	if (!isset($context['resource_class']) \|\| isset($context['api_sub_level'])) {	1,304✔
UNCOV 84	return $this->normalizeRawCollection($data, $format, $context);	712✔
85	}
86
UNCOV 87	$resourceClass = $this->resourceClassResolver->getResourceClass($data, $context['resource_class']);	821✔
UNCOV 88	$collectionContext = $this->initContext($resourceClass, $context);	821✔
UNCOV 89	$normalizedData = [];	821✔
UNCOV 90	$paginationData = $this->getPaginationData($data, $collectionContext);	821✔
91
UNCOV 92	$childContext = $this->createOperationContext($collectionContext, $resourceClass);	821✔
UNCOV 93	if (isset($collectionContext['force_resource_class'])) {	821✔
UNCOV 94	$childContext['force_resource_class'] = $collectionContext['force_resource_class'];	25✔
95	}
96
UNCOV 97	$itemsData = $this->getItemsData($data, $format, $childContext);	821✔
98
UNCOV 99	return array_merge_recursive($normalizedData, $paginationData, $itemsData);	821✔
100	}
101
102	/**
103	* Normalizes a raw collection (not API resources).
104	*/
105	protected function normalizeRawCollection(iterable $object, ?string $format = null, array $context = []): array\|\ArrayObject
106	{
UNCOV 107	if ([] === $object && ($context[Serializer::EMPTY_ARRAY_AS_OBJECT] ?? false)) {	712✔
108	return new \ArrayObject();	2✔
109	}
110
UNCOV 111	$data = [];	712✔
UNCOV 112	foreach ($object as $index => $obj) {	712✔
UNCOV 113	$data[$index] = $this->normalizer->normalize($obj, $format, $context);	474✔
114	}
115
UNCOV 116	return $data;	712✔
117	}
118
119	/**
120	* Gets the pagination configuration.
121	*/
122	protected function getPaginationConfig(iterable $object, array $context = []): array
123	{
UNCOV 124	$currentPage = $lastPage = $itemsPerPage = $pageTotalItems = $totalItems = null;	116✔
UNCOV 125	$paginated = $paginator = false;	116✔
126
UNCOV 127	if ($object instanceof PartialPaginatorInterface) {	116✔
UNCOV 128	$paginated = $paginator = true;	90✔
UNCOV 129	if ($object instanceof PaginatorInterface) {	90✔
UNCOV 130	$paginated = 1. !== $lastPage = $object->getLastPage();	89✔
UNCOV 131	$totalItems = $object->getTotalItems();	89✔
132	} else {
133	$pageTotalItems = (float) \count($object);	1✔
134	}
135
UNCOV 136	$currentPage = $object->getCurrentPage();	90✔
UNCOV 137	$itemsPerPage = $object->getItemsPerPage();	90✔
UNCOV 138	} elseif (is_countable($object)) {	26✔
UNCOV 139	$totalItems = \count($object);	22✔
140	}
141
UNCOV 142	return [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems];	116✔
143	}
144
145	protected function getOperation(array $context = []): Operation
146	{
147	$metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? '');	×
148
149	return $metadata->getOperation($context['operation_name'] ?? null);	×
150	}
151
152	/**
153	* Gets the pagination data.
154	*/
155	abstract protected function getPaginationData(iterable $object, array $context = []): array;
156
157	/**
158	* Gets items data.
159	*/
160	abstract protected function getItemsData(iterable $object, ?string $format = null, array $context = []): array;
161	}

api-platform / core / 20847864477

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous