9.5/_date_time_converter_test_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Tests\Unit\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!

 */


use ‪TYPO3\CMS\Extbase\Property\Exception\TypeConverterException;

use ‪TYPO3\CMS\Extbase\Tests\Unit\Property\TypeConverter\Fixtures\DateTimeSubFixture;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪DateTimeConverterTest extends UnitTestCase

{

    protected ‪$converter;


    protected function ‪setUp()

    {

        $this->converter = new \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter();

    }


    public function ‪checkMetadata()

    {

        $this->assertEquals(['string', 'integer', 'array'], $this->converter->getSupportedSourceTypes(), 'Source types do not match');

        $this->assertEquals('DateTime', $this->converter->getSupportedTargetType(), 'Target type does not match');

        $this->assertEquals(10, $this->converter->getPriority(), 'Priority does not match');

    }


    public function ‪canConvertFromReturnsFalseIfTargetTypeIsNotDateTime()

    {

        $this->assertFalse($this->converter->canConvertFrom('Foo', 'SomeOtherType'));

    }


    public function ‪canConvertFromReturnsTrueIfSourceTypeIsAString()

    {

        $this->assertTrue($this->converter->canConvertFrom('Foo', 'DateTime'));

    }


    public function ‪canConvertFromReturnsTrueIfSourceTypeIsAnEmptyString()

    {

        $this->assertTrue($this->converter->canConvertFrom('', 'DateTime'));

    }


    public function ‪convertFromReturnsErrorIfGivenStringCantBeConverted()

    {

        $error = $this->converter->convertFrom('1980-12-13', 'DateTime');

        $this->assertInstanceOf(\‪TYPO3\CMS\‪Extbase\Error\Error::class, $error);

    }


    public function ‪convertFromProperlyConvertsStringWithDefaultDateFormat()

    {

        $expectedResult = '1980-12-13T20:15:07+01:23';

        $date = $this->converter->convertFrom($expectedResult, 'DateTime');

        $actualResult = $date->format('Y-m-d\\TH:i:sP');

        $this->assertSame($expectedResult, $actualResult);

    }


    public function ‪convertFromUsesDefaultDateFormatIfItIsNotConfigured()

    {

        $expectedResult = '1980-12-13T20:15:07+01:23';

        $mockMappingConfiguration = $this->createMock(\‪TYPO3\CMS\‪Extbase\Property\PropertyMappingConfigurationInterface::class);

        $mockMappingConfiguration

                ->expects($this->atLeastOnce())

                ->method('getConfigurationValue')

                ->with(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT)

                ->will($this->returnValue(null));


        $date = $this->converter->convertFrom($expectedResult, 'DateTime', [], $mockMappingConfiguration);

        $actualResult = $date->format(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT);

        $this->assertSame($expectedResult, $actualResult);

    }


    public function ‪convertFromEmptyStringReturnsNull()

    {

        $date = $this->converter->convertFrom('', 'DateTime', [], null);

        $this->assertNull($date);

    }


    public function ‪convertFromStringDataProvider()

    {

        return [

            ['1308174051', '', false],

            ['13-12-1980', 'd.m.Y', false],

            ['1308174051', 'Y-m-d', false],

            ['12:13', 'H:i', true],

            ['13.12.1980', 'd.m.Y', true],

            ['2005-08-15T15:52:01+00:00', null, true],

            ['2005-08-15T15:52:01+00:00', \DateTime::ATOM, true],

            ['1308174051', 'U', true],

        ];

    }


    public function ‪convertFromStringTests($source, $dateFormat, $isValid)

    {

        if ($dateFormat !== null) {

            $mockMappingConfiguration = $this->createMock(\‪TYPO3\CMS\‪Extbase\Property\PropertyMappingConfigurationInterface::class);

            $mockMappingConfiguration

                    ->expects($this->atLeastOnce())

                    ->method('getConfigurationValue')

                    ->with(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT)

                    ->will($this->returnValue($dateFormat));

        } else {

            $mockMappingConfiguration = null;

        }

        $date = $this->converter->convertFrom($source, 'DateTime', [], $mockMappingConfiguration);

        if ($isValid !== true) {

            $this->assertInstanceOf(\‪TYPO3\CMS\‪Extbase\Error\Error::class, $date);

            return;

        }

        $this->assertInstanceOf('DateTime', $date);


        if ($dateFormat === null) {

            $dateFormat = ‪\TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT;

        }

        $this->assertSame($source, $date->format($dateFormat));

    }


    public function ‪convertFromIntegerOrDigitStringsWithoutConfigurationDataProvider()

    {

        return [

            ['1308174051'],

            [1308174051],

        ];

    }


    public function ‪convertFromIntegerOrDigitStringWithoutConfigurationTests($source)

    {

        $date = $this->converter->convertFrom($source, 'DateTime', [], null);

        $this->assertInstanceOf('DateTime', $date);

        $this->assertSame(strval($source), $date->format('U'));

    }


    public function ‪convertFromIntegerOrDigitStringInArrayWithoutConfigurationTests($source)

    {

        $date = $this->converter->convertFrom(['date' => $source], 'DateTime', [], null);

        $this->assertInstanceOf('DateTime', $date);

        $this->assertSame(strval($source), $date->format('U'));

    }


    public function ‪canConvertFromReturnsTrueIfSourceTypeIsAnArray()

    {

        $this->assertTrue($this->converter->canConvertFrom([], 'DateTime'));

    }


    public function ‪convertFromReturnsErrorIfGivenArrayCantBeConverted()

    {

        $error = $this->converter->convertFrom(['date' => '1980-12-13'], 'DateTime');

        $this->assertInstanceOf(\‪TYPO3\CMS\‪Extbase\Error\Error::class, $error);

    }


    public function ‪convertFromThrowsExceptionIfGivenArrayDoesNotSpecifyTheDate()

    {

        $this->expectException(TypeConverterException::class);

        $this->expectExceptionCode(1308003914);

        $this->converter->convertFrom(['hour' => '12', 'minute' => '30'], 'DateTime');

    }


    public function ‪convertFromProperlyConvertsArrayWithDefaultDateFormat()

    {

        $expectedResult = '1980-12-13T20:15:07+01:23';

        $date = $this->converter->convertFrom(['date' => $expectedResult], 'DateTime');

        $actualResult = $date->format('Y-m-d\\TH:i:sP');

        $this->assertSame($expectedResult, $actualResult);

    }


    public function ‪invalidDatePartKeyValuesDataProvider()

    {

        return [

            [['day' => '13.0', 'month' => '10', 'year' => '2010']],

            [['day' => '13', 'month' => '10.0', 'year' => '2010']],

            [['day' => '13', 'month' => '10', 'year' => '2010.0']],

            [['day' => '-13', 'month' => '10', 'year' => '2010']],

            [['day' => '13', 'month' => '-10', 'year' => '2010']],

            [['day' => '13', 'month' => '10', 'year' => '-2010']],

        ];

    }


    public function ‪convertFromThrowsExceptionIfDatePartKeysHaveInvalidValuesSpecified($source)

    {

        $this->expectException(TypeConverterException::class);

        $this->expectExceptionCode(1308003914);

        $this->converter->convertFrom($source, 'DateTime');

    }


    public function ‪convertFromProperlyConvertsArrayWithDateAsArray()

    {

        $source = ['day' => '13', 'month' => '10', 'year' => '2010'];

        $mappingConfiguration = new \TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration();

        $mappingConfiguration->setTypeConverterOption(

            \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::class,

            \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT,

            'Y-m-d'

        );


        $date = $this->converter->convertFrom($source, 'DateTime', [], $mappingConfiguration);

        $actualResult = $date->format('Y-m-d');

        $this->assertSame('2010-10-13', $actualResult);

    }


    public function ‪convertFromAllowsToOverrideTheTime()

    {

        $source = [

            'date' => '2011-06-16',

            'dateFormat' => 'Y-m-d',

            'hour' => '12',

            'minute' => '30',

            'second' => '59',

        ];

        $date = $this->converter->convertFrom($source, 'DateTime');

        $this->assertSame('2011-06-16', $date->format('Y-m-d'));

        $this->assertSame('12', $date->format('H'));

        $this->assertSame('30', $date->format('i'));

        $this->assertSame('59', $date->format('s'));

    }


    public function ‪convertFromAllowsToOverrideTheTimezone()

    {

        $source = [

            'date' => '2011-06-16 12:30:59',

            'dateFormat' => 'Y-m-d H:i:s',

            'timezone' => 'Atlantic/Reykjavik',

        ];

        $date = $this->converter->convertFrom($source, 'DateTime');

        $this->assertSame('2011-06-16', $date->format('Y-m-d'));

        $this->assertSame('12', $date->format('H'));

        $this->assertSame('30', $date->format('i'));

        $this->assertSame('59', $date->format('s'));

        $this->assertSame('Atlantic/Reykjavik', $date->getTimezone()->getName());

    }


    public function ‪convertFromThrowsExceptionIfSpecifiedTimezoneIsInvalid()

    {

        $this->expectException(TypeConverterException::class);

        $this->expectExceptionCode(1308240974);

        $source = [

            'date' => '2011-06-16',

            'dateFormat' => 'Y-m-d',

            'timezone' => 'Invalid/Timezone',

        ];

        $this->converter->convertFrom($source, 'DateTime');

    }


    public function ‪convertFromArrayThrowsExceptionForEmptyArray()

    {

        $this->expectException(TypeConverterException::class);

        $this->expectExceptionCode(1308003914);

        $this->converter->convertFrom([], 'DateTime', [], null);

    }


    public function ‪convertFromArrayReturnsNullForEmptyDate()

    {

        $this->assertNull($this->converter->convertFrom(['date' => ''], 'DateTime', [], null));

    }


    public function ‪convertFromArrayDataProvider()

    {

        return [

            [['date' => '2005-08-15T15:52:01+01:00'], true],

            [['date' => '1308174051', 'dateFormat' => ''], false],

            [['date' => '13-12-1980', 'dateFormat' => 'd.m.Y'], false],

            [['date' => '1308174051', 'dateFormat' => 'Y-m-d'], false],

            [['date' => '12:13', 'dateFormat' => 'H:i'], true],

            [['date' => '13.12.1980', 'dateFormat' => 'd.m.Y'], true],

            [['date' => '2005-08-15T15:52:01+00:00', 'dateFormat' => ''], true],

            [['date' => '2005-08-15T15:52:01+00:00', 'dateFormat' => \DateTime::ATOM], true],

            [['date' => '1308174051', 'dateFormat' => 'U'], true],

            [['date' => 1308174051, 'dateFormat' => 'U'], true],

        ];

    }


    public function ‪convertFromArrayTests(array $source, $isValid)

    {

        $dateFormat = isset($source['dateFormat']) && $source['dateFormat'] !== '' ? $source['dateFormat'] : null;

        if ($dateFormat !== null) {

            $mockMappingConfiguration = $this->createMock(\‪TYPO3\CMS\‪Extbase\Property\PropertyMappingConfigurationInterface::class);

            $mockMappingConfiguration

                    ->expects($this->atLeastOnce())

                    ->method('getConfigurationValue')

                    ->with(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT)

                    ->will($this->returnValue($dateFormat));

        } else {

            $mockMappingConfiguration = null;

        }

        $date = $this->converter->convertFrom($source, 'DateTime', [], $mockMappingConfiguration);


        if ($isValid !== true) {

            $this->assertInstanceOf(\‪TYPO3\CMS\‪Extbase\Error\Error::class, $date);

            return;

        }


        $this->assertInstanceOf('DateTime', $date);

        if ($dateFormat === null) {

            $dateFormat = ‪\TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT;

        }

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

        $this->assertSame($dateAsString, $date->format($dateFormat));

    }


    public function ‪convertFromSupportsDateTimeSubClasses()

    {

        $className = DateTimeSubFixture::class;

        $date = $this->converter->convertFrom('2005-08-15T15:52:01+00:00', $className);


        $this->assertInstanceOf($className, $date);

        $this->assertSame('Bar', $date->foo());

    }

}