Docs4dev
Docs
symfony / 2.7 / symfony / component / form / extension / core / datatransformer / datetimetoarraytransformer.html

DateTimeToArrayTransformer

class DateTimeToArrayTransformer extends BaseDateTimeTransformer

Transforms between a normalized time and a localized time string/array.

Methods

__construct(string $inputTimezone = null, string $outputTimezone = null, array $fields = null, bool $pad = false)
mixed transform(DateTime|DateTimeInterface $dateTime)

Transforms a normalized date into a localized date.
mixed reverseTransform(mixed $value)

Transforms a localized date into a normalized date.

Details

__construct(string $inputTimezone = null, string $outputTimezone = null, array $fields = null, bool $pad = false)

Parameters

string $inputTimezone The name of the input timezone
string $outputTimezone The name of the output timezone
array $fields The date fields
bool $pad Whether to use padding

Exceptions

UnexpectedTypeException if a timezone is not a string

mixed transform(DateTime|DateTimeInterface $dateTime)

Transforms a normalized date into a localized date.

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 localized date into a normalized date.

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 an array, if the value could not be transformed

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Form/Extension/Core/DataTransformer/DateTimeToArrayTransformer.html