-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make time zone for slugs configurable
Slugs of dates are generated during import. This might lead to confusion if the time zone differs from frontend. Therefore the time zone is now configurable to allow adjustments for the actual website. A new interface `TimeZoneProviderInterface` is provided which can be re configured to a different implementation. The default implementation will use TYPO3s `SYS.phpTimeZone` setting, with fall back to `date_default_timezone_get()` call. That way it should be useful for most systems out of the box. Resolves: #11345
- Loading branch information
1 parent
2d6c13e
commit 6b17b82
Showing
6 changed files
with
160 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/* | ||
* Copyright (C) 2024 Daniel Siepmann <daniel.siepmann@codappix.com> | ||
* | ||
* This program is free software; you can redistribute it and/or | ||
* modify it under the terms of the GNU General Public License | ||
* as published by the Free Software Foundation; either version 2 | ||
* of the License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU General Public License | ||
* along with this program; if not, write to the Free Software | ||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | ||
* 02110-1301, USA. | ||
*/ | ||
|
||
namespace WerkraumMedia\Events\Domain\TimeZone; | ||
|
||
use DateTimeZone; | ||
|
||
interface TimeZoneProviderInterface | ||
{ | ||
public function getTimeZone(): DateTimeZone; | ||
} |
37 changes: 37 additions & 0 deletions
37
Classes/Domain/TimeZone/Typo3ConfiguredTimeZoneProvider.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/* | ||
* Copyright (C) 2024 Daniel Siepmann <daniel.siepmann@codappix.com> | ||
* | ||
* This program is free software; you can redistribute it and/or | ||
* modify it under the terms of the GNU General Public License | ||
* as published by the Free Software Foundation; either version 2 | ||
* of the License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU General Public License | ||
* along with this program; if not, write to the Free Software | ||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | ||
* 02110-1301, USA. | ||
*/ | ||
|
||
namespace WerkraumMedia\Events\Domain\TimeZone; | ||
|
||
use DateTimeZone; | ||
|
||
final class Typo3ConfiguredTimeZoneProvider implements TimeZoneProviderInterface | ||
{ | ||
public function getTimeZone(): DateTimeZone | ||
{ | ||
$timeZone = $GLOBALS['TYPO3_CONF_VARS']['SYS']['phpTimeZone'] ?? null; | ||
$timeZone = $timeZone ?: date_default_timezone_get(); | ||
|
||
return new DateTimeZone($timeZone); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
4.3.0 | ||
===== | ||
|
||
Breaking | ||
-------- | ||
|
||
Nothing | ||
|
||
Features | ||
-------- | ||
|
||
Nothing | ||
|
||
Fixes | ||
----- | ||
|
||
* Make time zone for slugs configurable. | ||
|
||
Slugs of dates are generated during import. | ||
This might lead to confusion if the time zone differs from frontend. | ||
Therefore the time zone is now configurable to allow adjustments for the actual | ||
website. | ||
|
||
A new interface `TimeZoneProviderInterface` is provided which can be re configured to a | ||
different implementation. | ||
|
||
The default implementation will use TYPO3s `SYS.phpTimeZone` setting, with fall | ||
back to `date_default_timezone_get()` call. | ||
That way it should be useful for most systems out of the box. | ||
|
||
Tasks | ||
----- | ||
|
||
Nothing | ||
|
||
Deprecation | ||
----------- | ||
|
||
Nothing |
46 changes: 46 additions & 0 deletions
46
Tests/Functional/Import/DestinationDataTest/ImportsWithSystemConfiguredTimeZoneTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace WerkraumMedia\Events\Tests\Functional\Import\DestinationDataTest; | ||
|
||
use DateTimeImmutable; | ||
use DateTimeZone; | ||
use GuzzleHttp\Psr7\Response; | ||
use PHPUnit\Framework\Attributes\Test; | ||
use PHPUnit\Framework\Attributes\TestDox; | ||
use TYPO3\CMS\Core\Utility\ArrayUtility; | ||
|
||
#[TestDox('DestinationData import')] | ||
class ImportsWithSystemConfiguredTimeZoneTest extends AbstractTestCase | ||
{ | ||
public function setUp(): void | ||
{ | ||
ArrayUtility::mergeRecursiveWithOverrule($this->configurationToUseInTestInstance, [ | ||
'SYS' => [ | ||
'phpTimeZone' => 'Europe/Berlin', | ||
], | ||
]); | ||
|
||
parent::setUp(); | ||
|
||
$this->setUpConfiguration([ | ||
'restUrl = https://example.com/some-path/', | ||
]); | ||
$this->importPHPDataSet(__DIR__ . '/Fixtures/Database/DefaultImportConfiguration.php'); | ||
$this->setDateAspect(new DateTimeImmutable('2022-07-13', new DateTimeZone('UTC'))); | ||
} | ||
|
||
#[Test] | ||
public function withTYPO3TimeZone(): void | ||
{ | ||
$this->setUpResponses([new Response(200, [], file_get_contents(__DIR__ . '/Fixtures/ResponseWithSingleDate.json') ?: '')]); | ||
|
||
$this->executeCommand(); | ||
|
||
$dates = $this->getAllRecords('tx_events_domain_model_date'); | ||
self::assertSame('kurzfuehrung-historische-altstadt-2022-07-13t15-00-00', $dates[0]['slug']); | ||
|
||
$this->assertEmptyLog(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters