b2pweb / bdf-serializer

src/Normalizer/DateTimeNormalizer.php

<?php

namespace Bdf\Serializer\Normalizer;

use Bdf\Serializer\Context\DenormalizationContext;
use Bdf\Serializer\Context\NormalizationContext;
use Bdf\Serializer\Type\Type;
use DateTime;
use DateTimeImmutable;
use DateTimeInterface;
use DateTimeZone;

/**
 * DateTimeNormalizer
 *
 * @implements NormalizerInterface<\DateTime|\DateTimeImmutable>
 */
class DateTimeNormalizer implements NormalizerInterface
{
    /**
     * The default date format used for normalization
     *
     * @var string
     */
    private $defaultFormat;

    /**
     * DateTimeNormalizer constructor.
     *
     * @param string $defaultFormat   The default date format used by normalization
     */
    public function __construct(string $defaultFormat = DateTime::ATOM)
    {
        $this->defaultFormat = $defaultFormat;
    }

    /**
     * {@inheritdoc}
     */
    public function normalize($data, NormalizationContext $context)
    {
        $timezone = $context->option(NormalizationContext::TIMEZONE);

        if ($timezone !== null) {
            // Dont change date instance if it is not immutable
            if (!$data instanceof DateTimeImmutable) {
                $data = clone $data;
            }

            $data = $data->setTimezone(new DateTimeZone($timezone));
        }

        return $data->format($context->option(NormalizationContext::DATETIME_FORMAT, $this->defaultFormat));

$this->defaultFormat of type string is incompatible with the type Bdf\Serializer\Context\T expected by parameter $default of Bdf\Serializer\Context\Context::option().

    }

    /**
     * {@inheritdoc}
     *
     * @psalm-suppress InvalidNullableReturnType
     */
    public function denormalize($data, Type $type, DenormalizationContext $context)
    {
        // @fixme does this case really occurs ? No other normalizer handle this case
        if ($data === null) {
            /** @psalm-suppress NullableReturnStatement */
            return null;
        }

        $className = $type->name();
        $format = $context->option(DenormalizationContext::DATETIME_FORMAT);
        $timezoneHint = $context->option(DenormalizationContext::TIMEZONE_HINT);
        $timezone = $context->option(DenormalizationContext::TIMEZONE);

        if ($timezoneHint !== null) {
            $timezoneHint = new DateTimeZone($timezoneHint);
        }

        if ($format !== null) {
            /** @var \DateTime|\DateTimeImmutable $date */
            $date = $className::createFromFormat($format, $data, $timezoneHint);
        } else {
            /** @psalm-suppress UnsafeInstantiation */
            $date = new $className($data, $timezoneHint);
        }

        if ($timezone !== null) {
            /** @psalm-suppress PossiblyFalseReference */
            $date = $date->setTimezone(new DateTimeZone($timezone));
        }

        return $date;

The expression return $date also could return the type DateTime|DateTimeImmutable which is incompatible with the return type mandated by Bdf\Serializer\Normalizer\NormalizerInterface::denormalize() of Bdf\Serializer\Normalizer\T.

    }

    /**
     * {@inheritdoc}
     */
    public function supports(string $className): bool
    {
        return is_subclass_of($className, DateTimeInterface::class);
    }
}