DateTimeNormalizer
in package
implements
NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
Normalizes an object implementing the {@see \DateTimeInterface} to a date string.
Denormalizes a date string to an instance of DateTime or DateTimeImmutable.
Tags
Interfaces, Classes, Traits and Enums
- NormalizerInterface
- DenormalizerInterface
- CacheableSupportsMethodInterface
- Marker interface for normalizers and denormalizers that use only the type and the format in their supports*() methods.
Table of Contents
- FORMAT_KEY = 'datetime_format'
- TIMEZONE_KEY = 'datetime_timezone'
- SUPPORTED_TYPES = [\DateTimeInterface::class => true, \DateTimeImmutable::class => true, \DateTime::class => true]
- $defaultContext : mixed
- __construct() : mixed
- denormalize() : DateTimeInterface
- Denormalizes data back into an object of the given class.
- hasCacheableSupportsMethod() : bool
- normalize() : string
- Normalizes an object into a set of arrays/scalars.
- supportsDenormalization() : bool
- Checks whether the given class is supported for denormalization by this normalizer.
- supportsNormalization() : bool
- Checks whether the given class is supported for normalization by this normalizer.
- formatDateTimeErrors() : array<string|int, string>
- Formats datetime errors.
- getTimezone() : DateTimeZone|null
Constants
FORMAT_KEY
public
mixed
FORMAT_KEY
= 'datetime_format'
TIMEZONE_KEY
public
mixed
TIMEZONE_KEY
= 'datetime_timezone'
SUPPORTED_TYPES
private
mixed
SUPPORTED_TYPES
= [\DateTimeInterface::class => true, \DateTimeImmutable::class => true, \DateTime::class => true]
Properties
$defaultContext
private
mixed
$defaultContext
Methods
__construct()
public
__construct([array<string|int, mixed> $defaultContext = [] ][, DateTimeZone $timezone = null ]) : mixed
Parameters
- $defaultContext : array<string|int, mixed> = []
- $timezone : DateTimeZone = null
Return values
mixed —denormalize()
Denormalizes data back into an object of the given class.
public
denormalize(mixed $data, mixed $type[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : DateTimeInterface
Parameters
- $data : mixed
-
Data to restore
- $type : mixed
-
The expected class to instantiate
- $format : mixed = null
-
Format the given data was extracted from
- $context : array<string|int, mixed> = []
-
Options available to the denormalizer
Tags
Return values
DateTimeInterface —hasCacheableSupportsMethod()
public
hasCacheableSupportsMethod() : bool
Return values
bool —normalize()
Normalizes an object into a set of arrays/scalars.
public
normalize(mixed $object[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : string
Parameters
- $object : mixed
-
Object to normalize
- $format : mixed = null
-
Format the normalization result will be encoded as
- $context : array<string|int, mixed> = []
-
Context options for the normalizer
Tags
Return values
string —supportsDenormalization()
Checks whether the given class is supported for denormalization by this normalizer.
public
supportsDenormalization(mixed $data, mixed $type[, mixed $format = null ]) : bool
Parameters
- $data : mixed
-
Data to denormalize from
- $type : mixed
-
The class to which the data should be denormalized
- $format : mixed = null
-
The format being deserialized from
Return values
bool —supportsNormalization()
Checks whether the given class is supported for normalization by this normalizer.
public
supportsNormalization(mixed $data[, mixed $format = null ]) : bool
Parameters
- $data : mixed
-
Data to normalize
- $format : mixed = null
-
The format being (de-)serialized from or into
Return values
bool —formatDateTimeErrors()
Formats datetime errors.
private
formatDateTimeErrors(array<string|int, mixed> $errors) : array<string|int, string>
Parameters
- $errors : array<string|int, mixed>
Return values
array<string|int, string> —getTimezone()
private
getTimezone(array<string|int, mixed> $context) : DateTimeZone|null
Parameters
- $context : array<string|int, mixed>