15133993414

Committed 20 May 2025 09:30AM UTC coverage: 26.313% (-1.2%) from 27.493%

Build # 15133993414

Build Type

Pull #7161

github

Committed by

web-flow

Commit Message

Merge e2c03d45f into 5459ba375

Pull Request Pull Request #7161: fix(metadata): infer parameter string type from schema

Run Details

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

11019 existing lines in 363 files now uncovered.

12898 of 49018 relevant lines covered (26.31%)

34.33 hits per line

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

100.0

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

use ApiPlatform\JsonLd\ContextBuilderInterface;
use ApiPlatform\JsonLd\Serializer\HydraPrefixTrait;
use ApiPlatform\JsonLd\Serializer\JsonLdContextTrait;
use ApiPlatform\Metadata\IriConverterInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\Metadata\UrlGeneratorInterface;
use ApiPlatform\Serializer\AbstractCollectionNormalizer;
use ApiPlatform\State\Pagination\PaginatorInterface;
use ApiPlatform\State\Pagination\PartialPaginatorInterface;

/**
 * This normalizer handles collections.
 *
 * @author Kevin Dunglas <dunglas@gmail.com>
 * @author Samuel ROZE <samuel.roze@gmail.com>
 */
final class CollectionNormalizer extends AbstractCollectionNormalizer
{
    use HydraPrefixTrait;
    use JsonLdContextTrait;

    public const FORMAT = 'jsonld';
    public const IRI_ONLY = 'iri_only';
    private array $defaultContext = [
        self::IRI_ONLY => false,
    ];

    public function __construct(private readonly ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, array $defaultContext = [])
    {
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext);

        parent::__construct($resourceClassResolver, '');
    }

    /**
     * Gets the pagination data.
     */
    protected function getPaginationData(iterable $object, array $context = []): array
    {
        $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
        $hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);
        // This adds "jsonld_has_context" by reference, we moved the code to this class.
        // To follow a note I wrote in the ItemNormalizer, we need to change the JSON-LD context generation as it is more complicated then it should.
        $data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
        $data['@id'] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);
        $data['@type'] = $hydraPrefix.'Collection';

        if ($object instanceof PaginatorInterface) {
            $data[$hydraPrefix.'totalItems'] = $object->getTotalItems();
        }

        if (\is_array($object) || ($object instanceof \Countable && !$object instanceof PartialPaginatorInterface)) {
            $data[$hydraPrefix.'totalItems'] = \count($object);
        }

        return $data;
    }

    /**
     * Gets items data.
     */
    protected function getItemsData(iterable $object, ?string $format = null, array $context = []): array
    {
        $hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);
        $data = [$hydraPrefix.'member' => []];
        $iriOnly = $context[self::IRI_ONLY] ?? $this->defaultContext[self::IRI_ONLY];

        foreach ($object as $obj) {
            if ($iriOnly) {
                $data[$hydraPrefix.'member'][] = $this->iriConverter->getIriFromResource($obj);
            } else {
                $data[$hydraPrefix.'member'][] = $this->normalizer->normalize($obj, $format, $context + ['jsonld_has_context' => true]);
            }
        }

        return $data;
    }

    protected function initContext(string $resourceClass, array $context): array
    {
        $context = parent::initContext($resourceClass, $context);
        $context['api_collection_sub_level'] = true;

        return $context;
    }
}

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\Hydra\Serializer;
15
16	use ApiPlatform\JsonLd\ContextBuilderInterface;
17	use ApiPlatform\JsonLd\Serializer\HydraPrefixTrait;
18	use ApiPlatform\JsonLd\Serializer\JsonLdContextTrait;
19	use ApiPlatform\Metadata\IriConverterInterface;
20	use ApiPlatform\Metadata\ResourceClassResolverInterface;
21	use ApiPlatform\Metadata\UrlGeneratorInterface;
22	use ApiPlatform\Serializer\AbstractCollectionNormalizer;
23	use ApiPlatform\State\Pagination\PaginatorInterface;
24	use ApiPlatform\State\Pagination\PartialPaginatorInterface;
25
26	/**
27	* This normalizer handles collections.
28	*
29	* @author Kevin Dunglas <dunglas@gmail.com>
30	* @author Samuel ROZE <samuel.roze@gmail.com>
31	*/
32	final class CollectionNormalizer extends AbstractCollectionNormalizer
33	{
34	use HydraPrefixTrait;
35	use JsonLdContextTrait;
36
37	public const FORMAT = 'jsonld';
38	public const IRI_ONLY = 'iri_only';
39	private array $defaultContext = [
40	self::IRI_ONLY => false,
41	];
42
43	public function __construct(private readonly ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, array $defaultContext = [])
44	{
UNCOV 45	$this->defaultContext = array_merge($this->defaultContext, $defaultContext);	950✔
46
UNCOV 47	parent::__construct($resourceClassResolver, '');	950✔
48	}
49
50	/**
51	* Gets the pagination data.
52	*/
53	protected function getPaginationData(iterable $object, array $context = []): array
54	{
UNCOV 55	$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);	286✔
UNCOV 56	$hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);	286✔
57	// This adds "jsonld_has_context" by reference, we moved the code to this class.
58	// To follow a note I wrote in the ItemNormalizer, we need to change the JSON-LD context generation as it is more complicated then it should.
UNCOV 59	$data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);	286✔
UNCOV 60	$data['@id'] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);	286✔
UNCOV 61	$data['@type'] = $hydraPrefix.'Collection';	286✔
62
UNCOV 63	if ($object instanceof PaginatorInterface) {	286✔
UNCOV 64	$data[$hydraPrefix.'totalItems'] = $object->getTotalItems();	257✔
65	}
66
UNCOV 67	if (\is_array($object) \|\| ($object instanceof \Countable && !$object instanceof PartialPaginatorInterface)) {	286✔
UNCOV 68	$data[$hydraPrefix.'totalItems'] = \count($object);	27✔
69	}
70
UNCOV 71	return $data;	286✔
72	}
73
74	/**
75	* Gets items data.
76	*/
77	protected function getItemsData(iterable $object, ?string $format = null, array $context = []): array
78	{
UNCOV 79	$hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);	286✔
UNCOV 80	$data = [$hydraPrefix.'member' => []];	286✔
UNCOV 81	$iriOnly = $context[self::IRI_ONLY] ?? $this->defaultContext[self::IRI_ONLY];	286✔
82
UNCOV 83	foreach ($object as $obj) {	286✔
UNCOV 84	if ($iriOnly) {	263✔
85	$data[$hydraPrefix.'member'][] = $this->iriConverter->getIriFromResource($obj);	1✔
86	} else {
UNCOV 87	$data[$hydraPrefix.'member'][] = $this->normalizer->normalize($obj, $format, $context + ['jsonld_has_context' => true]);	262✔
88	}
89	}
90
UNCOV 91	return $data;	286✔
92	}
93
94	protected function initContext(string $resourceClass, array $context): array
95	{
UNCOV 96	$context = parent::initContext($resourceClass, $context);	286✔
UNCOV 97	$context['api_collection_sub_level'] = true;	286✔
98
UNCOV 99	return $context;	286✔
100	}
101	}

api-platform / core / 15133993414

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