9.5/_date_time_converter_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Property\TypeConverter;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


class ‪DateTimeConverter extends ‪\TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter

{

    const ‪CONFIGURATION_DATE_FORMAT = 'dateFormat';


    const ‪DEFAULT_DATE_FORMAT = \DateTime::W3C;


    protected ‪$sourceTypes = ['string', 'integer', 'array'];


    protected ‪$targetType = 'DateTime';


    protected ‪$priority = 10;


    public function ‪canConvertFrom($source, ‪$targetType)

    {

        if (!is_callable([‪$targetType, 'createFromFormat'])) {

            return false;

        }

        if (is_array($source)) {

            return true;

        }

        if (is_int($source)) {

            return true;

        }

        return is_string($source);

    }


    public function ‪convertFrom($source, ‪$targetType, array $convertedChildProperties = [], \‪TYPO3\CMS\‪Extbase\Property\‪PropertyMappingConfigurationInterface $configuration = null)

    {

        $dateFormat = $this->‪getDefaultDateFormat($configuration);

        if (is_string($source)) {

            $dateAsString = $source;

        } elseif (is_int($source)) {

            $dateAsString = strval($source);

        } else {

            if (isset($source['date']) && is_string($source['date'])) {

                $dateAsString = $source['date'];

            } elseif (isset($source['date']) && is_int($source['date'])) {

                $dateAsString = strval($source['date']);

            } elseif ($this->‪isDatePartKeysProvided($source)) {

                if ($source['day'] < 1 || $source['month'] < 1 || $source['year'] < 1) {

                    return new \TYPO3\CMS\Extbase\Error\Error('Could not convert the given date parts into a DateTime object because one or more parts were 0.', 1333032779);

                }

                $dateAsString = sprintf('%d-%d-%d', $source['year'], $source['month'], $source['day']);

            } else {

                throw new \TYPO3\CMS\Extbase\Property\Exception\TypeConverterException('Could not convert the given source into a DateTime object because it was not an array with a valid date as a string', 1308003914);

            }

            if (isset($source['dateFormat']) && $source['dateFormat'] !== '') {

                $dateFormat = $source['dateFormat'];

            }

        }

        if ($dateAsString === '') {

            return null;

        }

        if (ctype_digit($dateAsString) && $configuration === null && (!is_array($source) || !isset($source['dateFormat']))) {

            $dateFormat = 'U';

        }

        if (is_array($source) && isset($source['timezone']) && (string)$source['timezone'] !== '') {

            try {

                $timezone = new \DateTimeZone($source['timezone']);

            } catch (\Exception $e) {

                throw new \TYPO3\CMS\Extbase\Property\Exception\TypeConverterException('The specified timezone "' . $source['timezone'] . '" is invalid.', 1308240974);

            }

            $date = $targetType::createFromFormat($dateFormat, $dateAsString, $timezone);

        } else {

            $date = $targetType::createFromFormat($dateFormat, $dateAsString);

        }

        if ($date === false) {

            return new \TYPO3\CMS\Extbase\Validation\Error('The date "%s" was not recognized (for format "%s").', 1307719788, [$dateAsString, $dateFormat]);

        }

        if (is_array($source)) {

            $date = $this->‪overrideTimeIfSpecified($date, $source);

        }

        return $date;

    }


    protected function ‪isDatePartKeysProvided(array $source)

    {

        return isset($source['day']) && ctype_digit($source['day'])

            && isset($source['month']) && ctype_digit($source['month'])

            && isset($source['year']) && ctype_digit($source['year']);

    }


    protected function ‪getDefaultDateFormat(\‪TYPO3\CMS\‪Extbase\Property\PropertyMappingConfigurationInterface $configuration = null)

    {

        if ($configuration === null) {

            return ‪self::DEFAULT_DATE_FORMAT;

        }

        $dateFormat = $configuration->getConfigurationValue(DateTimeConverter::class, self::CONFIGURATION_DATE_FORMAT);

        if ($dateFormat === null) {

            return ‪self::DEFAULT_DATE_FORMAT;

        }

        if ($dateFormat !== null && !is_string($dateFormat)) {

            throw new \TYPO3\CMS\Extbase\Property\Exception\InvalidPropertyMappingConfigurationException('CONFIGURATION_DATE_FORMAT must be of type string, "' . (is_object($dateFormat) ? get_class($dateFormat) : gettype($dateFormat)) . '" given', 1307719569);

        }

        return $dateFormat;

    }


    protected function ‪overrideTimeIfSpecified(\DateTimeInterface $date, array $source): \DateTimeInterface

    {

        if (!isset($source['hour']) && !isset($source['minute']) && !isset($source['second'])) {

            return $date;

        }

        $hour = isset($source['hour']) ? (int)$source['hour'] : 0;

        $minute = isset($source['minute']) ? (int)$source['minute'] : 0;

        $second = isset($source['second']) ? (int)$source['second'] : 0;

        return $date->setTime($hour, $minute, $second);

    }

}