5644825543

pending completion

Build # 5644825543

Build Type

push

github

Committed by

web-flow

Commit Message

feat(serializer): support for getSupportedTypes (symfony 6.3) (#5672)

Run Details

109 of 109 new or added lines in 29 files covered. (100.0%)

10881 of 18245 relevant lines covered (59.64%)

20.04 hits per line

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

78.95

/src/JsonApi/Serializer/ErrorNormalizer.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\JsonApi\Serializer;

use ApiPlatform\Problem\Serializer\ErrorNormalizerTrait;
use Symfony\Component\ErrorHandler\Exception\FlattenException;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Converts {@see \Exception} or {@see FlattenException} or to a JSON API error representation.
 *
 * @author Héctor Hurtarte <hectorh30@gmail.com>
 */
final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
{
    use ErrorNormalizerTrait;

    public const FORMAT = 'jsonapi';
    public const TITLE = 'title';
    private array $defaultContext = [
        self::TITLE => 'An error occurred',
    ];

    public function __construct(private readonly bool $debug = false, array $defaultContext = [])
    {
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
    }

    /**
     * {@inheritdoc}
     */
    public function normalize(mixed $object, string $format = null, array $context = []): array
    {
        $data = [
            'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
            'description' => $this->getErrorMessage($object, $context, $this->debug),
        ];

        if (null !== $errorCode = $this->getErrorCode($object)) {
            $data['code'] = $errorCode;
        }

        if ($this->debug && null !== $trace = $object->getTrace()) {
            $data['trace'] = $trace;
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
    {
        return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException);
    }

    public function getSupportedTypes($format): array
    {
        if (self::FORMAT === $format) {
            return [
                \Exception::class => true,
                FlattenException::class => true,
            ];
        }

        return [];
    }

    public function hasCacheableSupportsMethod(): bool
    {
        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);

        return true;
    }
}

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\JsonApi\Serializer;
15
16	use ApiPlatform\Problem\Serializer\ErrorNormalizerTrait;
17	use Symfony\Component\ErrorHandler\Exception\FlattenException;
18	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
19	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
20
21	/**
22	* Converts {@see \Exception} or {@see FlattenException} or to a JSON API error representation.
23	*
24	* @author Héctor Hurtarte <hectorh30@gmail.com>
25	*/
26	final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
27	{
28	use ErrorNormalizerTrait;
29
30	public const FORMAT = 'jsonapi';
31	public const TITLE = 'title';
32	private array $defaultContext = [
33	self::TITLE => 'An error occurred',
34	];
35
36	public function __construct(private readonly bool $debug = false, array $defaultContext = [])
37	{
38	$this->defaultContext = array_merge($this->defaultContext, $defaultContext);	72✔
39	}
40
41	/**
42	* {@inheritdoc}
43	*/
44	public function normalize(mixed $object, string $format = null, array $context = []): array
45	{
46	$data = [	16✔
47	'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],	16✔
48	'description' => $this->getErrorMessage($object, $context, $this->debug),	16✔
49	];	16✔
50
51	if (null !== $errorCode = $this->getErrorCode($object)) {	16✔
52	$data['code'] = $errorCode;	4✔
53	}
54
55	if ($this->debug && null !== $trace = $object->getTrace()) {	16✔
56	$data['trace'] = $trace;	6✔
57	}
58
59	return $data;	16✔
60	}
61
62	/**
63	* {@inheritdoc}
64	*/
65	public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
66	{
67	return self::FORMAT === $format && ($data instanceof \Exception \|\| $data instanceof FlattenException);	2✔
68	}
69
70	public function getSupportedTypes($format): array
71	{
72	if (self::FORMAT === $format) {	42✔
73	return [	×
74	\Exception::class => true,	×
75	FlattenException::class => true,	×
76	];	×
77	}
78
79	return [];	42✔
80	}
81
82	public function hasCacheableSupportsMethod(): bool
83	{
84	trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);	2✔
85
86	return true;	2✔
87	}
88	}

api-platform / core / 5644825543

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