• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

api-platform / core / 14855288206

06 May 2025 08:38AM UTC coverage: 8.457% (-0.002%) from 8.459%
14855288206

push

github

soyuka
fix: type info deprecations to baseline

bc layer covered on main

13397 of 158416 relevant lines covered (8.46%)

22.88 hits per line

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

81.82
/src/Symfony/EventListener/ReadListener.php
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\Symfony\EventListener;
15

16
use ApiPlatform\Metadata\Exception\InvalidIdentifierException;
17
use ApiPlatform\Metadata\Exception\InvalidUriVariableException;
18
use ApiPlatform\Metadata\HttpOperation;
19
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
20
use ApiPlatform\Metadata\UriVariablesConverterInterface;
21
use ApiPlatform\Metadata\Util\CloneTrait;
22
use ApiPlatform\State\ProviderInterface;
23
use ApiPlatform\State\UriVariablesResolverTrait;
24
use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
25
use ApiPlatform\State\Util\RequestAttributesExtractor;
26
use Symfony\Component\HttpKernel\Event\RequestEvent;
27
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
28

29
/**
30
 * Retrieves data from the applicable data provider and sets it as a request parameter called data.
31
 *
32
 * @author Kévin Dunglas <dunglas@gmail.com>
33
 */
34
final class ReadListener
35
{
36
    use CloneTrait;
37
    use OperationRequestInitiatorTrait;
38
    use UriVariablesResolverTrait;
39

40
    /**
41
     * @param ProviderInterface<object> $provider
42
     */
43
    public function __construct(
44
        private readonly ProviderInterface $provider,
45
        ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null,
46
        ?UriVariablesConverterInterface $uriVariablesConverter = null,
47
    ) {
48
        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
224✔
49
        $this->uriVariablesConverter = $uriVariablesConverter;
224✔
50
    }
51

52
    /**
53
     * Calls the data provider and sets the data attribute.
54
     *
55
     * @throws NotFoundHttpException
56
     */
57
    public function onKernelRequest(RequestEvent $event): void
58
    {
59
        $request = $event->getRequest();
224✔
60

61
        if (!($attributes = RequestAttributesExtractor::extractAttributes($request)) || !$attributes['receive']) {
224✔
62
            return;
29✔
63
        }
64

65
        $operation = $this->initializeOperation($request);
198✔
66
        if (!$operation) {
198✔
67
            return;
×
68
        }
69

70
        if (null === $operation->canRead()) {
198✔
71
            $operation = $operation->withRead($operation->getUriVariables() || $request->isMethodSafe());
197✔
72
        }
73

74
        $uriVariables = [];
198✔
75
        if (!$request->attributes->has('exception') && $operation instanceof HttpOperation) {
198✔
76
            try {
77
                $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
197✔
78
            } catch (InvalidIdentifierException|InvalidUriVariableException $e) {
×
79
                if ($operation->canRead()) {
×
80
                    throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
×
81
                }
82
            }
83
        }
84

85
        $request->attributes->set('_api_uri_variables', $uriVariables);
198✔
86
        $this->provider->provide($operation, $uriVariables, [
198✔
87
            'request' => $request,
198✔
88
            'uri_variables' => $uriVariables,
198✔
89
            'resource_class' => $operation->getClass(),
198✔
90
        ]);
198✔
91
    }
92
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc