#27627

pending completion

Build # #27627

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/901141aff07d60a030b415921d707c257e3bd6b7">901141aff<a href="https://github.com/api-platform/core/commit/901141aff07d60a030b415921d707c257e3bd6b7">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/d1b9c5983dd396390b08e7d64f1c6f9a88b36d20">d1b9c5983</a>">d1b9c5983</a><a href="https://github.com/api-platform/core/commit/901141aff07d60a030b415921d707c257e3bd6b7"> into 9b1dc7188">9b1dc7188</a>

Run Details

444 of 444 new or added lines in 39 files covered. (100.0%)

13173 of 15970 relevant lines covered (82.49%)

14.82 hits per line

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

88.64

/src/Metadata/Resource/Factory/IdentifierResourceMetadataCollectionFactory.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\Metadata\Resource\Factory;

use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;

/**
 * Helps creating metadata on the Resource based on the properties of this same resource. Computes "identifiers".
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 * @experimental
 */
final class IdentifierResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    private $decorated;
    private $propertyNameCollectionFactory;
    private $propertyMetadataFactory;

    public function __construct(ResourceMetadataCollectionFactoryInterface $decorated, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory)
    {
        $this->decorated = $decorated;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function create(string $resourceClass): ResourceMetadataCollection
    {
        $resourceMetadataCollection = $this->decorated->create($resourceClass);

        $identifiers = null;
        foreach ($resourceMetadataCollection as $i => $resource) {
            if (!$resource->getIdentifiers()) {
                $resource = $resource->withIdentifiers($identifiers ?: ($identifiers = $this->getIdentifiersFromResourceClass($resourceClass)));
            } else {
                $identifiers = $resource->getIdentifiers();
            }

            $resource = $resource->withIdentifiers($this->normalizeIdentifiers($resource->getIdentifiers(), $resourceClass));

            $operations = $resource->getOperations();
            // Copy identifiers to operations if not defined
            foreach ($operations as $key => $operation) {
                if ($identifiers && !$operation->getIdentifiers() && !$operation->isCollection()) {
                    if (0 === $i && 1 < \count($identifiers) && null === $operation->getCompositeIdentifier()) {
                        trigger_deprecation('api-platform/core', '2.7', sprintf('You have multiple identifiers on the resource "%s" but did not specify the "compositeIdentifier" property, we will set this to "true". Not specifying this attribute in 3.0 will break.', $resourceClass));
                        $operation = $operation->withCompositeIdentifier(true);
                    }

                    $operation = $operation->withIdentifiers($identifiers);
                }

                $operations->add($key, $operation->withIdentifiers($this->normalizeIdentifiers($operation->getIdentifiers(), $resourceClass)));
            }

            $resourceMetadataCollection[$i] = $resource->withOperations($operations);
        }

        return $resourceMetadataCollection;
    }

    private function normalizeIdentifiers($identifiers, string $resourceClass): array
    {
        if (!$identifiers) {
            return [];
        }

        if (\is_string($identifiers)) {
            return [$identifiers => [$resourceClass, $identifiers]];
        }

        $normalized = [];

        foreach ($identifiers as $parameterName => $identifier) {
            if (\is_int($parameterName)) {
                $normalized[$identifier] = [$resourceClass, $identifier];
            } elseif (\is_string($identifier)) {
                $normalized[$parameterName] = [$resourceClass, $identifier];
            } else {
                $normalized[$parameterName] = $identifier;
            }
        }

        return $normalized;
    }

    private function getIdentifiersFromResourceClass(string $resourceClass): array
    {
        $identifiers = [];
        $hasIdProperty = false;
        foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
            $hasIdProperty = 'id' === $property;
            if ($this->propertyMetadataFactory->create($resourceClass, $property)->isIdentifier() ?? false) {
                $identifiers[$property] = [$resourceClass, $property];
            }
        }

        if (!$identifiers) {
            if ($hasIdProperty) {
                return ['id' => [$resourceClass, 'id']];
            }

            return $identifiers;
        }

        return $identifiers;
    }
}

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\Metadata\Resource\Factory;
15
16	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
17	use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
18	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
19
20	/**
21	* Helps creating metadata on the Resource based on the properties of this same resource. Computes "identifiers".
22	*
23	* @author Antoine Bluchet <soyuka@gmail.com>
24	* @experimental
25	*/
26	final class IdentifierResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
27	{
28	private $decorated;
29	private $propertyNameCollectionFactory;
30	private $propertyMetadataFactory;
31
32	public function __construct(ResourceMetadataCollectionFactoryInterface $decorated, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory)
33	{
34	$this->decorated = $decorated;	38✔
35	$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;	38✔
36	$this->propertyMetadataFactory = $propertyMetadataFactory;	38✔
37	}	38✔
38
39	/**
40	* {@inheritdoc}
41	*/
42	public function create(string $resourceClass): ResourceMetadataCollection
43	{
44	$resourceMetadataCollection = $this->decorated->create($resourceClass);	3✔
45
46	$identifiers = null;	3✔
47	foreach ($resourceMetadataCollection as $i => $resource) {	3✔
48	if (!$resource->getIdentifiers()) {	2✔
49	$resource = $resource->withIdentifiers($identifiers ?: ($identifiers = $this->getIdentifiersFromResourceClass($resourceClass)));	2✔
50	} else {
51	$identifiers = $resource->getIdentifiers();	1✔
52	}
53
54	$resource = $resource->withIdentifiers($this->normalizeIdentifiers($resource->getIdentifiers(), $resourceClass));	2✔
55
56	$operations = $resource->getOperations();	2✔
57	// Copy identifiers to operations if not defined
58	foreach ($operations as $key => $operation) {	2✔
59	if ($identifiers && !$operation->getIdentifiers() && !$operation->isCollection()) {	2✔
60	if (0 === $i && 1 < \count($identifiers) && null === $operation->getCompositeIdentifier()) {	1✔
61	trigger_deprecation('api-platform/core', '2.7', sprintf('You have multiple identifiers on the resource "%s" but did not specify the "compositeIdentifier" property, we will set this to "true". Not specifying this attribute in 3.0 will break.', $resourceClass));	×
62	$operation = $operation->withCompositeIdentifier(true);	×
63	}
64
65	$operation = $operation->withIdentifiers($identifiers);	1✔
66	}
67
68	$operations->add($key, $operation->withIdentifiers($this->normalizeIdentifiers($operation->getIdentifiers(), $resourceClass)));	2✔
69	}
70
71	$resourceMetadataCollection[$i] = $resource->withOperations($operations);	2✔
72	}
73
74	return $resourceMetadataCollection;	3✔
75	}
76
77	private function normalizeIdentifiers($identifiers, string $resourceClass): array
78	{
79	if (!$identifiers) {	2✔
80	return [];	2✔
81	}
82
83	if (\is_string($identifiers)) {	1✔
84	return [$identifiers => [$resourceClass, $identifiers]];	1✔
85	}
86
87	$normalized = [];	1✔
88
89	foreach ($identifiers as $parameterName => $identifier) {	1✔
90	if (\is_int($parameterName)) {	1✔
91	$normalized[$identifier] = [$resourceClass, $identifier];	×
92	} elseif (\is_string($identifier)) {	1✔
93	$normalized[$parameterName] = [$resourceClass, $identifier];	×
94	} else {
95	$normalized[$parameterName] = $identifier;	1✔
96	}
97	}
98
99	return $normalized;	1✔
100	}
101
102	private function getIdentifiersFromResourceClass(string $resourceClass): array
103	{
104	$identifiers = [];	2✔
105	$hasIdProperty = false;	2✔
106	foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {	2✔
107	$hasIdProperty = 'id' === $property;	1✔
108	if ($this->propertyMetadataFactory->create($resourceClass, $property)->isIdentifier() ?? false) {	1✔
109	$identifiers[$property] = [$resourceClass, $property];	1✔
110	}
111	}
112
113	if (!$identifiers) {	2✔
114	if ($hasIdProperty) {	2✔
115	return ['id' => [$resourceClass, 'id']];	×
116	}
117
118	return $identifiers;	2✔
119	}
120
121	return $identifiers;	1✔
122	}
123	}

api-platform / core / #27627

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