Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DateIntervalNormalizer.php

class DateIntervalNormalizer

Normalizes an instance of {Denormalizes an interval string to an instance of { @author Jérôme Parmentier <jerome@prmntr.me>

Hierarchy

  • class \Symfony\Component\Serializer\Normalizer\DateIntervalNormalizer implements \Symfony\Component\Serializer\Normalizer\NormalizerInterface, \Symfony\Component\Serializer\Normalizer\DenormalizerInterface

Expanded class hierarchy of DateIntervalNormalizer

See also

\DateInterval} to an interval string.

\DateInterval}.

1 file declares its use of DateIntervalNormalizer
DateIntervalNormalizerContextBuilder.php in vendor/symfony/serializer/Context/Normalizer/DateIntervalNormalizerContextBuilder.php

File

vendor/symfony/serializer/Normalizer/DateIntervalNormalizer.php, line 23

Namespace

Symfony\Component\Serializer\Normalizer
View source
final class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface {
    public const FORMAT_KEY = 'dateinterval_format';
    private array $defaultContext = [
        self::FORMAT_KEY => '%rP%yY%mM%dDT%hH%iM%sS',
    ];
    public function __construct(array $defaultContext = []) {
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
    }
    public function getSupportedTypes(?string $format) : array {
        return [
            \DateInterval::class => true,
        ];
    }
    
    /**
     * @throws InvalidArgumentException
     */
    public function normalize(mixed $object, ?string $format = null, array $context = []) : string {
        if (!$object instanceof \DateInterval) {
            throw new InvalidArgumentException('The object must be an instance of "\\DateInterval".');
        }
        return $object->format($context[self::FORMAT_KEY] ?? $this->defaultContext[self::FORMAT_KEY]);
    }
    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []) : bool {
        return $data instanceof \DateInterval;
    }
    
    /**
     * @throws NotNormalizableValueException
     */
    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []) : \DateInterval {
        if (!\is_string($data)) {
            throw NotNormalizableValueException::createForUnexpectedDataType('Data expected to be a string.', $data, [
                'string',
            ], $context['deserialization_path'] ?? null, true);
        }
        if (!$this->isISO8601($data)) {
            throw NotNormalizableValueException::createForUnexpectedDataType('Expected a valid ISO 8601 interval string.', $data, [
                'string',
            ], $context['deserialization_path'] ?? null, true);
        }
        $dateIntervalFormat = $context[self::FORMAT_KEY] ?? $this->defaultContext[self::FORMAT_KEY];
        $signPattern = '';
        switch (substr($dateIntervalFormat, 0, 2)) {
            case '%R':
                $signPattern = '[-+]';
                $dateIntervalFormat = substr($dateIntervalFormat, 2);
                break;
            case '%r':
                $signPattern = '-?';
                $dateIntervalFormat = substr($dateIntervalFormat, 2);
                break;
        }
        $valuePattern = '/^' . $signPattern . preg_replace('/%([yYmMdDhHiIsSwW])(\\w)/', '(?:(?P<$1>\\d+)$2)?', preg_replace('/(T.*)$/', '($1)?', $dateIntervalFormat)) . '$/';
        if (!preg_match($valuePattern, $data)) {
            throw NotNormalizableValueException::createForUnexpectedDataType(\sprintf('Value "%s" contains intervals not accepted by format "%s".', $data, $dateIntervalFormat), $data, [
                'string',
            ], $context['deserialization_path'] ?? null, false);
        }
        try {
            if ('-' === $data[0]) {
                $interval = new \DateInterval(substr($data, 1));
                $interval->invert = 1;
                return $interval;
            }
            if ('+' === $data[0]) {
                return new \DateInterval(substr($data, 1));
            }
            return new \DateInterval($data);
        } catch (\Exception $e) {
            throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, [
                'string',
            ], $context['deserialization_path'] ?? null, false, $e->getCode(), $e);
        }
    }
    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []) : bool {
        return \DateInterval::class === $type;
    }
    private function isISO8601(string $string) : bool {
        return preg_match('/^[\\-+]?P(?=\\w*(?:\\d|%\\w))(?:\\d+Y|%[yY]Y)?(?:\\d+M|%[mM]M)?(?:\\d+W|%[wW]W)?(?:\\d+D|%[dD]D)?(?:T(?:\\d+H|[hH]H)?(?:\\d+M|[iI]M)?(?:\\d+S|[sS]S)?)?$/', $string);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DateIntervalNormalizer::$defaultContext private property
DateIntervalNormalizer::denormalize public function Overrides DenormalizerInterface::denormalize
DateIntervalNormalizer::FORMAT_KEY public constant
DateIntervalNormalizer::getSupportedTypes public function Returns the types potentially supported by this normalizer. Overrides NormalizerInterface::getSupportedTypes
DateIntervalNormalizer::isISO8601 private function
DateIntervalNormalizer::normalize public function Overrides NormalizerInterface::normalize
DateIntervalNormalizer::supportsDenormalization public function Checks whether the given class is supported for denormalization by this normalizer. Overrides DenormalizerInterface::supportsDenormalization
DateIntervalNormalizer::supportsNormalization public function Checks whether the given class is supported for normalization by this normalizer. Overrides NormalizerInterface::supportsNormalization
DateIntervalNormalizer::__construct public function
DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS public constant
RSS feed
Powered by Drupal