DateTimeToTimestampTransformer

class DateTimeToTimestampTransformer extends BaseDateTimeTransformer

Transforms between a timestamp and a DateTime object.

Methods

__construct(string $inputTimezone = null, string $outputTimezone = null)

Constructor.

from BaseDateTimeTransformer
mixed transform(DateTime|DateTimeInterface $dateTime)

Transforms a DateTime object into a timestamp in the configured timezone.

mixed reverseTransform(mixed $value)

Transforms a timestamp in the configured timezone into a DateTime object.

Details

__construct(string $inputTimezone = null, string $outputTimezone = null)

Constructor.

Parameters

string $inputTimezone The name of the input timezone
string $outputTimezone The name of the output timezone

Exceptions

UnexpectedTypeException if a timezone is not a string
InvalidArgumentException if a timezone is not valid

mixed transform(DateTime|DateTimeInterface $dateTime)

Transforms a DateTime object into a timestamp in the configured timezone.

Parameters

DateTime|DateTimeInterface $dateTime A DateTime object

Return Value

mixed The value in the transformed representation

Exceptions

TransformationFailedException If the given value is not an instance of \DateTime or \DateTimeInterface

mixed reverseTransform(mixed $value)

Transforms a timestamp in the configured timezone into a DateTime object.

Parameters

mixed $value The value in the transformed representation

Return Value

mixed The value in the original representation

Exceptions

TransformationFailedException If the given value is not a timestamp or if the given timestamp is invalid