#25889

pending completion

Build # #25889

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/d89c42ce6d00effd6e40c1d57f97d4569d54c61a">d89c42ce6<a href="https://github.com/api-platform/core/commit/d89c42ce6d00effd6e40c1d57f97d4569d54c61a">">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/720432545da9f1931074a024a0ccbdb4cdcb3bea">720432545</a>">720432545</a><a href="https://github.com/api-platform/core/commit/d89c42ce6d00effd6e40c1d57f97d4569d54c61a"> into d52f09a25">d52f09a25</a>

Run Details

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

8145 of 9669 relevant lines covered (84.24%)

14.91 hits per line

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

86.36

/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\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');
        }

        return $this->subresourceDataProvider->getSubresource($attributes['resource_class'], $identifiers, $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)
    {
        if (isset($attributes['item_operation_name'])) {
            if (!isset($parameters['id'])) {
                throw new InvalidIdentifierException('Parameter "id" not found');
            }

            $id = $parameters['id'];

            if (null !== $this->identifierConverter) {
                return $this->identifierConverter->convert((string) $id, $attributes['resource_class']);
            }

            return $id;
        }

        if (!isset($attributes['subresource_context'])) {
            throw new RuntimeException('Either "item_operation_name" or "collection_operation_name" must be defined, unless the "_api_receive" request attribute is set to false.');
        }

        $identifiers = [];

        foreach ($attributes['subresource_context']['identifiers'] as $key => [$id, $resourceClass, $hasIdentifier]) {
            if (false === $hasIdentifier) {
                continue;
            }

            $identifiers[$id] = $parameters[$id];

            if (null !== $this->identifierConverter) {
                $identifiers[$id] = $this->identifierConverter->convert((string) $identifiers[$id], $resourceClass);
            }
        }

        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\Core\DataProvider;
15
16	use ApiPlatform\Core\Exception\InvalidIdentifierException;
17	use ApiPlatform\Core\Exception\RuntimeException;
18	use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
19
20	/**
21	* @internal
22	*/
23	trait OperationDataProviderTrait
24	{
25	/**
26	* @var CollectionDataProviderInterface
27	*/
28	private $collectionDataProvider;
29
30	/**
31	* @var ItemDataProviderInterface
32	*/
33	private $itemDataProvider;
34
35	/**
36	* @var SubresourceDataProviderInterface\|null
37	*/
38	private $subresourceDataProvider;
39
40	/**
41	* @var IdentifierConverterInterface\|null
42	*/
43	private $identifierConverter;
44
45	/**
46	* Retrieves data for a collection operation.
47	*
48	* @return iterable
49	*/
50	private function getCollectionData(array $attributes, array $context)
51	{
52	return $this->collectionDataProvider->getCollection($attributes['resource_class'], $attributes['collection_operation_name'], $context);	8✔
53	}
54
55	/**
56	* Gets data for an item operation.
57	*
58	* @return object\|null
59	*/
60	private function getItemData($identifiers, array $attributes, array $context)
61	{
62	return $this->itemDataProvider->getItem($attributes['resource_class'], $identifiers, $attributes['item_operation_name'], $context);	8✔
63	}
64
65	/**
66	* Gets data for a nested operation.
67	*
68	* @throws RuntimeException
69	*
70	* @return array\|object\|null
71	*/
72	private function getSubresourceData($identifiers, array $attributes, array $context)
73	{
74	if (null === $this->subresourceDataProvider) {	3✔
75	throw new RuntimeException('Subresources not supported');	×
76	}
77
78	return $this->subresourceDataProvider->getSubresource($attributes['resource_class'], $identifiers, $attributes['subresource_context'] + $context, $attributes['subresource_operation_name']);	3✔
79	}
80
81	/**
82	* @param array $parameters - usually comes from $request->attributes->all()
83	*
84	* @throws InvalidIdentifierException
85	*/
86	private function extractIdentifiers(array $parameters, array $attributes)
87	{
88	if (isset($attributes['item_operation_name'])) {	17✔
89	if (!isset($parameters['id'])) {	11✔
90	throw new InvalidIdentifierException('Parameter "id" not found');	1✔
91	}
92
93	$id = $parameters['id'];	10✔
94
95	if (null !== $this->identifierConverter) {	10✔
96	return $this->identifierConverter->convert((string) $id, $attributes['resource_class']);	7✔
97	}
98
99	return $id;	3✔
100	}
101
102	if (!isset($attributes['subresource_context'])) {	6✔
103	throw new RuntimeException('Either "item_operation_name" or "collection_operation_name" must be defined, unless the "_api_receive" request attribute is set to false.');	×
104	}
105
106	$identifiers = [];	6✔
107
108	foreach ($attributes['subresource_context']['identifiers'] as $key => [$id, $resourceClass, $hasIdentifier]) {	6✔
109	if (false === $hasIdentifier) {	6✔
110	continue;	×
111	}
112
113	$identifiers[$id] = $parameters[$id];	6✔
114
115	if (null !== $this->identifierConverter) {	6✔
116	$identifiers[$id] = $this->identifierConverter->convert((string) $identifiers[$id], $resourceClass);	4✔
117	}
118	}
119
120	return $identifiers;	4✔
121	}
122	}

api-platform / core / #25889

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