15973247443

Committed 30 Jun 2025 12:44PM UTC coverage: 22.065% (+0.001%) from 22.064%

Build # 15973247443

Build Type

push

github

Committed by

web-flow

Commit Message

chore: use treat phpdoc type as certain (#7250)

Run Details

8 of 16 new or added lines in 13 files covered. (50.0%)

123 existing lines in 11 files now uncovered.

11518 of 52201 relevant lines covered (22.06%)

22.04 hits per line

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

0.0

/src/Elasticsearch/State/ItemProvider.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\Elasticsearch\State;

use ApiPlatform\Elasticsearch\Serializer\DocumentNormalizer;
use ApiPlatform\Metadata\InflectorInterface;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Util\Inflector;
use ApiPlatform\State\ApiResource\Error;
use ApiPlatform\State\ProviderInterface;
use Elastic\Elasticsearch\Client;
use Elastic\Elasticsearch\Exception\ClientResponseException;
use Elastic\Elasticsearch\Response\Elasticsearch;
use Elasticsearch\Client as V7Client;
use Elasticsearch\Common\Exceptions\Missing404Exception as V7Missing404Exception;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;

/**
 * Item provider for Elasticsearch.
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class ItemProvider implements ProviderInterface
{
    public function __construct(
        private readonly V7Client|Client $client, // @phpstan-ignore-line
        private readonly ?DenormalizerInterface $denormalizer = null,
        private readonly ?InflectorInterface $inflector = new Inflector(),
    ) {
    }

    /**
     * {@inheritdoc}
     */
    public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?object
    {
        $resourceClass = $operation->getClass();
        $options = $operation->getStateOptions();
        if (!$options instanceof Options) {
            $options = new Options(index: $this->getIndex($operation));
        }

        $params = [
            'index' => $options->getIndex() ?? $this->getIndex($operation),
            'id' => (string) reset($uriVariables),
        ];

        try {
            $document = $this->client->get($params); // @phpstan-ignore-line
        } catch (V7Missing404Exception) { // @phpstan-ignore-line
            return null;
        } catch (ClientResponseException $e) {
            $response = $e->getResponse();
            if (404 === $response->getStatusCode()) {
                return null;
            }

            throw new Error(status: $response->getStatusCode(), detail: (string) $response->getBody(), title: $response->getReasonPhrase(), originalTrace: $e->getTrace());
        }

        if (class_exists(Elasticsearch::class) && $document instanceof Elasticsearch) {
            $document = $document->asArray();
        }

        $item = $this->denormalizer->denormalize($document, $resourceClass, DocumentNormalizer::FORMAT, [AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => true]);
        if (!\is_object($item) && null !== $item) {
            throw new \UnexpectedValueException('Expected item to be an object or null.');
        }

        return $item;
    }

    private function getIndex(Operation $operation): string
    {
        return $this->inflector->tableize($operation->getShortName());
    }
}

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\Elasticsearch\State;
15
16	use ApiPlatform\Elasticsearch\Serializer\DocumentNormalizer;
17	use ApiPlatform\Metadata\InflectorInterface;
18	use ApiPlatform\Metadata\Operation;
19	use ApiPlatform\Metadata\Util\Inflector;
20	use ApiPlatform\State\ApiResource\Error;
21	use ApiPlatform\State\ProviderInterface;
22	use Elastic\Elasticsearch\Client;
23	use Elastic\Elasticsearch\Exception\ClientResponseException;
24	use Elastic\Elasticsearch\Response\Elasticsearch;
25	use Elasticsearch\Client as V7Client;
26	use Elasticsearch\Common\Exceptions\Missing404Exception as V7Missing404Exception;
27	use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
28	use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
29
30	/**
31	* Item provider for Elasticsearch.
32	*
33	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
34	* @author Vincent Chalamon <vincentchalamon@gmail.com>
35	*/
36	final class ItemProvider implements ProviderInterface
37	{
38	public function __construct(
39	private readonly V7Client\|Client $client, // @phpstan-ignore-line
40	private readonly ?DenormalizerInterface $denormalizer = null,
41	private readonly ?InflectorInterface $inflector = new Inflector(),
42	) {
43	}	×
44
45	/**
46	* {@inheritdoc}
47	*/
48	public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?object
49	{
50	$resourceClass = $operation->getClass();	×
NEW 51	$options = $operation->getStateOptions();	×
52	if (!$options instanceof Options) {	×
NEW 53	$options = new Options(index: $this->getIndex($operation));	×
54	}
55
56	$params = [	×
57	'index' => $options->getIndex() ?? $this->getIndex($operation),	×
58	'id' => (string) reset($uriVariables),	×
59	];	×
60
61	try {
62	$document = $this->client->get($params); // @phpstan-ignore-line	×
63	} catch (V7Missing404Exception) { // @phpstan-ignore-line	×
64	return null;	×
65	} catch (ClientResponseException $e) {	×
66	$response = $e->getResponse();	×
67	if (404 === $response->getStatusCode()) {	×
68	return null;	×
69	}
70
71	throw new Error(status: $response->getStatusCode(), detail: (string) $response->getBody(), title: $response->getReasonPhrase(), originalTrace: $e->getTrace());	×
72	}
73
74	if (class_exists(Elasticsearch::class) && $document instanceof Elasticsearch) {	×
75	$document = $document->asArray();	×
76	}
77
78	$item = $this->denormalizer->denormalize($document, $resourceClass, DocumentNormalizer::FORMAT, [AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => true]);	×
79	if (!\is_object($item) && null !== $item) {	×
80	throw new \UnexpectedValueException('Expected item to be an object or null.');	×
81	}
82
83	return $item;	×
84	}
85
86	private function getIndex(Operation $operation): string
87	{
88	return $this->inflector->tableize($operation->getShortName());	×
89	}
90	}

api-platform / core / 15973247443

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