#26322

pending completion

Build # #26322

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/9123c62e4ee2a5a6b932351aca022fdd713976d6">9123c62e4<a href="https://github.com/api-platform/core/commit/9123c62e4ee2a5a6b932351aca022fdd713976d6">">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/1fdb0e86070a009a2971b2810ca07f9ded38d7ff">1fdb0e860</a>">1fdb0e860</a><a href="https://github.com/api-platform/core/commit/9123c62e4ee2a5a6b932351aca022fdd713976d6"> into ed59e8df6">ed59e8df6</a>

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

9426 of 11392 relevant lines covered (82.74%)

14.83 hits per line

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

75.0

/src/DataProvider/OperationDataProviderTrait.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\Core\DataProvider;

use ApiPlatform\Core\Exception\InvalidIdentifierException;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Identifier\CompositeIdentifierParser;
use ApiPlatform\Core\Identifier\IdentifierConverterInterface;

/**
 * @internal
 */
trait OperationDataProviderTrait
{
    /**
     * @var CollectionDataProviderInterface
     */
    private $collectionDataProvider;

    /**
     * @var ItemDataProviderInterface
     */
    private $itemDataProvider;

    /**
     * @var SubresourceDataProviderInterface|null
     */
    private $subresourceDataProvider;

    /**
     * @var IdentifierConverterInterface|null
     */
    private $identifierConverter;

    /**
     * Retrieves data for a collection operation.
     *
     * @return iterable
     */
    private function getCollectionData(array $attributes, array $context)
    {
        return $this->collectionDataProvider->getCollection($attributes['resource_class'], $attributes['collection_operation_name'], $context);
    }

    /**
     * Gets data for an item operation.
     *
     * @return object|null
     */
    private function getItemData($identifiers, array $attributes, array $context)
    {
        return $this->itemDataProvider->getItem($attributes['resource_class'], $identifiers, $attributes['item_operation_name'], $context);
    }

    /**
     * Gets data for a nested operation.
     *
     * @throws RuntimeException
     *
     * @return array|object|null
     */
    private function getSubresourceData($identifiers, array $attributes, array $context)
    {
        if (null === $this->subresourceDataProvider) {
            throw new RuntimeException('Subresources not supported');
        }

        // TODO: SubresourceDataProvider wants: ['id' => ['id' => 1], 'relatedDummies' => ['id' => 2]], identifiers is ['id' => 1, 'relatedDummies' => 2]
        $subresourceIdentifiers = [];
        foreach ($attributes['identifiers'] as $parameterName => [$class, $property]) {
            if (false !== ($attributes['identifiers'][$parameterName][2] ?? null)) {
                $subresourceIdentifiers[$parameterName] = [$property => $identifiers[$parameterName]];
            }
        }

        return $this->subresourceDataProvider->getSubresource($attributes['resource_class'], $subresourceIdentifiers, $attributes['subresource_context'] + $context, $attributes['subresource_operation_name']);
    }

    /**
     * @param array $parameters - usually comes from $request->attributes->all()
     *
     * @throws InvalidIdentifierException
     */
    private function extractIdentifiers(array $parameters, array $attributes)
    {
        $identifiersKeys = $attributes['identifiers'] ?? ['id' => [$attributes['resource_class'], 'id']];
        $identifiers = [];

        $identifiersNumber = \count($identifiersKeys);
        foreach ($identifiersKeys as $parameterName => $identifiedBy) {
            if (!isset($parameters[$parameterName])) {
                if ($attributes['has_composite_identifier']) {
                    $identifiers = CompositeIdentifierParser::parse($parameters['id']);
                    if (($currentIdentifiersNumber = \count($identifiers)) !== $identifiersNumber) {
                        throw new InvalidIdentifierException(sprintf('Expected %d identifiers, got %d', $identifiersNumber, $currentIdentifiersNumber));
                    }

                    return $this->identifierConverter->convert($identifiers, $attributes['resource_class']);
                }

                // TODO: Subresources tuple may have a third item representing if it is a "collection", this behavior will be removed in 3.0
                if (false === ($identifiedBy[2] ?? null)) {
                    continue;
                }

                throw new InvalidIdentifierException(sprintf('Parameter "%s" not found', $parameterName));
            }

            $identifiers[$parameterName] = $parameters[$parameterName];
        }

        return $this->identifierConverter->convert($identifiers, $attributes['resource_class']);
    }
}

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\Core\DataProvider;
15
16	use ApiPlatform\Core\Exception\InvalidIdentifierException;
17	use ApiPlatform\Core\Exception\RuntimeException;
18	use ApiPlatform\Core\Identifier\CompositeIdentifierParser;
19	use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
20
21	/**
22	* @internal
23	*/
24	trait OperationDataProviderTrait
25	{
26	/**
27	* @var CollectionDataProviderInterface
28	*/
29	private $collectionDataProvider;
30
31	/**
32	* @var ItemDataProviderInterface
33	*/
34	private $itemDataProvider;
35
36	/**
37	* @var SubresourceDataProviderInterface\|null
38	*/
39	private $subresourceDataProvider;
40
41	/**
42	* @var IdentifierConverterInterface\|null
43	*/
44	private $identifierConverter;
45
46	/**
47	* Retrieves data for a collection operation.
48	*
49	* @return iterable
50	*/
51	private function getCollectionData(array $attributes, array $context)
52	{
53	return $this->collectionDataProvider->getCollection($attributes['resource_class'], $attributes['collection_operation_name'], $context);	8✔
54	}
55
56	/**
57	* Gets data for an item operation.
58	*
59	* @return object\|null
60	*/
61	private function getItemData($identifiers, array $attributes, array $context)
62	{
63	return $this->itemDataProvider->getItem($attributes['resource_class'], $identifiers, $attributes['item_operation_name'], $context);	8✔
64	}
65
66	/**
67	* Gets data for a nested operation.
68	*
69	* @throws RuntimeException
70	*
71	* @return array\|object\|null
72	*/
73	private function getSubresourceData($identifiers, array $attributes, array $context)
74	{
75	if (null === $this->subresourceDataProvider) {	3✔
76	throw new RuntimeException('Subresources not supported');	×
77	}
78
79	// TODO: SubresourceDataProvider wants: ['id' => ['id' => 1], 'relatedDummies' => ['id' => 2]], identifiers is ['id' => 1, 'relatedDummies' => 2]
80	$subresourceIdentifiers = [];	3✔
81	foreach ($attributes['identifiers'] as $parameterName => [$class, $property]) {	3✔
82	if (false !== ($attributes['identifiers'][$parameterName][2] ?? null)) {	3✔
83	$subresourceIdentifiers[$parameterName] = [$property => $identifiers[$parameterName]];	3✔
84	}
85	}
86
87	return $this->subresourceDataProvider->getSubresource($attributes['resource_class'], $subresourceIdentifiers, $attributes['subresource_context'] + $context, $attributes['subresource_operation_name']);	3✔
88	}
89
90	/**
91	* @param array $parameters - usually comes from $request->attributes->all()
92	*
93	* @throws InvalidIdentifierException
94	*/
95	private function extractIdentifiers(array $parameters, array $attributes)
96	{
97	$identifiersKeys = $attributes['identifiers'] ?? ['id' => [$attributes['resource_class'], 'id']];	17✔
98	$identifiers = [];	17✔
99
100	$identifiersNumber = \count($identifiersKeys);	17✔
101	foreach ($identifiersKeys as $parameterName => $identifiedBy) {	17✔
102	if (!isset($parameters[$parameterName])) {	17✔
103	if ($attributes['has_composite_identifier']) {	1✔
104	$identifiers = CompositeIdentifierParser::parse($parameters['id']);	×
105	if (($currentIdentifiersNumber = \count($identifiers)) !== $identifiersNumber) {	×
106	throw new InvalidIdentifierException(sprintf('Expected %d identifiers, got %d', $identifiersNumber, $currentIdentifiersNumber));	×
107	}
108
109	return $this->identifierConverter->convert($identifiers, $attributes['resource_class']);	×
110	}
111
112	// TODO: Subresources tuple may have a third item representing if it is a "collection", this behavior will be removed in 3.0
113	if (false === ($identifiedBy[2] ?? null)) {	1✔
114	continue;	×
115	}
116
117	throw new InvalidIdentifierException(sprintf('Parameter "%s" not found', $parameterName));	1✔
118	}
119
120	$identifiers[$parameterName] = $parameters[$parameterName];	16✔
121	}
122
123	return $this->identifierConverter->convert($identifiers, $attributes['resource_class']);	16✔
124	}
125	}

api-platform / core / #26322

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