Repository: symfony/symfony
File: src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php (PHP)

Code before:

use Symfony\Component\Serializer\Exception\BadMethodCallException;
use Symfony\Component\Serializer\Exception\ExceptionInterface;
use Symfony\Component\Serializer\Exception\ExtraAttributesException;
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Exception\RuntimeException;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;

/**
 * @author Jordi Boggiano <j.boggiano@seld.be>
 */
interface DenormalizerInterface
{
    public const COLLECT_DENORMALIZATION_ERRORS = 'collect_denormalization_errors';

    /**
     * Denormalizes data back into an object of the given class.
     *
     * @template TObject of object
     * @param mixed                             $data    Data to restore
     * @param class-string<TObject>|string|null $type    The expected class to instantiate
     * @param string|null                       $format  Format the given data was extracted from
     * @param array                             $context Options available to the denormalizer
     *
     * @phpstan-return ($type is class-string<TObject> ? TObject : mixed)
     *
     * @psalm-return ($type is class-string<TObject> ? TObject : mixed)
     *
     * @throws BadMethodCallException   Occurs when the normalizer is not called in an expected context
     * @throws InvalidArgumentException Occurs when the arguments are not coherent or not supported
     * @throws UnexpectedValueException Occurs when the item cannot be hydrated with the given data
     * @throws ExtraAttributesException Occurs when the item doesn't have attribute to receive given data
     * @throws LogicException           Occurs when the normalizer is not supposed to denormalize
     * @throws RuntimeException         Occurs if the class cannot be instantiated
     * @throws ExceptionInterface       Occurs for all the other cases of errors
     */
    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): mixed;

    /**
     * Checks whether the given class is supported for denormalization by this normalizer.
     *
     * @param mixed                $data    Data to denormalize from
     * @param string               $type    The class to which the data should be denormalized
     * @param string|null          $format  The format being deserialized from
     * @param array<string, mixed> $context Options available to the denormalizer
     */
    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool;

    /**
     * Returns the types potentially supported by this denormalizer.

Review comment (suggestion):
This allows [mago](https://github.com/carthage-software/mago) to understand that

```php
$payload = $this->denormalizer->denormalize($payload, JWTPayload::class);
```

results in `JWTPayload`, without the need for a special plugin / extension. 

Psalm and PHPStan extensions could also remove their stubs for this, as this works for them too.

ref:
- https://github.com/psalm/psalm-plugin-symfony/blob/e5f97e1257a28602ecf6871a74d361fc43ae12e4/src/Stubs/7/Component/Serializer/Normalizer/DenormalizerInterface.stubphp#L5-L15
- https://github.com/phpstan/phpstan-symfony/blob/60b312da9ce2a3778e236ccb081eecefa4df2e2e/stubs/Symfony/Component/Serializer/Normalizer/DenormalizableInterface.stub#L1-L16


Code after:

use Symfony\Component\Serializer\Exception\BadMethodCallException;
use Symfony\Component\Serializer\Exception\ExceptionInterface;
use Symfony\Component\Serializer\Exception\ExtraAttributesException;
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Exception\RuntimeException;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;

/**
 * @author Jordi Boggiano <j.boggiano@seld.be>
 */
interface DenormalizerInterface
{
    public const COLLECT_DENORMALIZATION_ERRORS = 'collect_denormalization_errors';

    /**
     * Denormalizes data back into an object of the given class.
     *
     * @template TObject of object
     *
     * @param mixed                        $data    Data to restore
     * @param class-string<TObject>|string $type    The expected class to instantiate
     * @param string|null                  $format  Format the given data was extracted from
     * @param array<string, mixed>         $context Options available to the denormalizer
     *
     * @return ($type is class-string<TObject> ? TObject : mixed)
     *
     * @throws BadMethodCallException   Occurs when the normalizer is not called in an expected context
     * @throws InvalidArgumentException Occurs when the arguments are not coherent or not supported
     * @throws UnexpectedValueException Occurs when the item cannot be hydrated with the given data
     * @throws ExtraAttributesException Occurs when the item doesn't have attribute to receive given data
     * @throws LogicException           Occurs when the normalizer is not supposed to denormalize
     * @throws RuntimeException         Occurs if the class cannot be instantiated
     * @throws ExceptionInterface       Occurs for all the other cases of errors
     */
    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): mixed;

    /**
     * Checks whether the given class is supported for denormalization by this normalizer.
     *
     * @param mixed                $data    Data to denormalize from
     * @param string               $type    The class to which the data should be denormalized
     * @param string|null          $format  The format being deserialized from
     * @param array<string, mixed> $context Options available to the denormalizer
     */
    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool;

    /**
     * Returns the types potentially supported by this denormalizer.
     *