Don't adjust the app's timezone, keep timezone management within Cms

Author: riasvdv

src/Cms.php

@@ -13,6 +13,8 @@
 use Illuminate\Support\Facades\Context;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Log;
+use IntlDateFormatter;
+use IntlException;
 use PDOException;
 use Throwable;
 
@@ -31,6 +33,30 @@ public static function config(): GeneralConfig
         return app(GeneralConfig::class) ?? GeneralConfig::create();
     }
 
+    public static function timezone(): string
+    {
+        $timezone = Cms::config()->timezone
+            ?? ProjectConfig::get('system.timeZone')
+            ?? config('app.timezone', 'UTC');
+
+        $timezone = Env::parse($timezone);
+
+        if ($timezone !== 'UTC') {
+            // Make sure that ICU supports this timezone
+            try {
+                $formatter = new IntlDateFormatter(app()->getLocale(), IntlDateFormatter::NONE, IntlDateFormatter::NONE);
+                if (! $formatter->setTimeZone($timezone)) {
+                    $timezone = 'UTC';
+                }
+            } catch (IntlException) {
+                Log::warning("Time zone “{$timezone}” does not appear to be supported by ICU: ".intl_get_error_message());
+                $timezone = 'UTC';
+            }
+        }
+
+        return $timezone;
+    }
+
     public static function systemName(): string
     {
         $name = Env::parse(ProjectConfig::get('system.name'));

src/Config/GeneralConfig.php

@@ -2961,6 +2961,24 @@ class GeneralConfig extends BaseConfig
      */
     public ?string $tempAssetUploadFs = null;
 
+    /**
+     * @var string|null The timezone of the site. If set, it will take precedence over the Timezone setting in Settings → General.
+     *
+     * This can be set to one of PHP’s [supported timezones](https://php.net/manual/en/timezones.php).
+     *
+     * ::: code
+     * ```php Static Config
+     * ->timezone('Europe/London')
+     * ```
+     * ```shell Environment Override
+     * CRAFT_TIMEZONE=Europe/London
+     * ```
+     * :::
+     *
+     * @group System
+     */
+    public ?string $timezone = null;
+
     /**
     /**
      * @var bool Whether GIF files should be cleansed/transformed.
@@ -6146,6 +6164,29 @@ public function tempAssetUploadFs(?string $value): self
         return $this;
     }
 
+    /**
+     * Configures Craft to send all system emails to either a single email address or an array of email addresses
+     * for testing purposes.
+     *
+     * The timezone of the site. If set, it will take precedence over the Timezone setting in Settings → General.
+     *
+     * This can be set to one of PHP’s [supported timezones](https://php.net/manual/en/timezones.php).
+     *
+     * ```php
+     * ->timezone('Europe/London')
+     * ```
+     *
+     * @group System
+     *
+     * @see $timezone
+     */
+    public function timezone(?string $value): self
+    {
+        $this->timezone = $value;
+
+        return $this;
+    }
+
     /**
      * Whether GIF files should be cleansed/transformed.
      *

src/Cp/Icons.php

@@ -5,6 +5,7 @@
 namespace CraftCms\Cms\Cp;
 
 use CraftCms\Aliases\Aliases;
+use CraftCms\Cms\Cms;
 use CraftCms\Cms\Support\Facades\I18N;
 use CraftCms\Cms\Support\Html;
 use Illuminate\Support\Facades\Log;
@@ -187,7 +188,7 @@ public static function fallbackSvg(string $label): string
 
     public static function earth(): string
     {
-        $tzGroup = explode('/', (string) app()->getTimezone(), 2)[0];
+        $tzGroup = explode('/', Cms::timezone(), 2)[0];
 
         return match ($tzGroup) {
             'Africa' => 'earth-africa',

src/Field/Date.php

@@ -6,6 +6,7 @@
 
 use craft\base\ElementInterface;
 use craft\helpers\Db;
+use CraftCms\Cms\Cms;
 use CraftCms\Cms\Entry\Elements\Entry;
 use CraftCms\Cms\Field\Conditions\DateFieldConditionRule;
 use CraftCms\Cms\Field\Contracts\CrossSiteCopyableFieldInterface;
@@ -228,7 +229,7 @@ public function getInputId(): string
     protected function inputHtml(mixed $value, ?ElementInterface $element, bool $inline): string
     {
         /** @var DateTime|null $value */
-        $timezone = $this->showTimeZone && $value ? $value->getTimezone()->getName() : app()->getTimezone();
+        $timezone = $this->showTimeZone && $value ? $value->getTimezone()->getName() : Cms::timezone();
 
         if ($value === null) {
             // Override the initial value being set to null by CustomField::inputHtml()

src/Gql/Directives/FormatDateTime.php

@@ -97,6 +97,6 @@ public static function apply(mixed $source, mixed $value, array $arguments, Reso
 
     public static function defaultTimeZone(): string
     {
-        return Cms::config()->setGraphqlDatesToSystemTimeZone ? app()->getTimezone() : self::DEFAULT_TIMEZONE;
+        return Cms::config()->setGraphqlDatesToSystemTimeZone ? Cms::timezone() : self::DEFAULT_TIMEZONE;
     }
 }

src/Providers/AppServiceProvider.php

@@ -15,7 +15,6 @@
 use CraftCms\Cms\Support\Facades\Updates;
 use CraftCms\Cms\Support\File;
 use GuzzleHttp\Utils;
-use Illuminate\Contracts\Config\Repository as ConfigRepository;
 use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Console\AboutCommand;
 use Illuminate\Foundation\Events\LocaleUpdated;
@@ -29,13 +28,10 @@
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Gate;
-use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Redirect;
 use Illuminate\Support\Facades\URL;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Validation\Rules\Password;
-use IntlDateFormatter;
-use IntlException;
 use Override;
 use ReflectionClass;
 use RuntimeException;
@@ -70,7 +66,6 @@ public function boot(): void
             'Version' => Cms::VERSION,
         ]);
 
-        $this->setTimezone();
         $this->setNamespace();
         $this->bootAliases();
 
@@ -121,11 +116,6 @@ private function registerMacros(): void
             return Env::parseBoolean(app(ProjectConfig::class)->get('system.live')) ?? false;
         });
 
-        Application::macro(
-            'getTimezone',
-            fn (): string => $this->make(ConfigRepository::class)->get('app.timezone') ?? date_default_timezone_get(),
-        );
-
         // Register Collection::one() as an alias of first()
         Collection::macro('one', fn () => $this->first(...func_get_args()));
 
@@ -196,31 +186,6 @@ private function registerMacros(): void
             ));
     }
 
-    private function setTimezone(): void
-    {
-        $timezone = app(ProjectConfig::class)->get('system.timeZone')
-            ?? $this->app->make(ConfigRepository::class)->get('app.timezone')
-            ?? 'UTC';
-
-        $timezone = Env::parse($timezone);
-
-        if ($timezone !== 'UTC') {
-            // Make sure that ICU supports this timezone
-            try {
-                $formatter = new IntlDateFormatter($this->app->getLocale(), IntlDateFormatter::NONE, IntlDateFormatter::NONE);
-                if (! $formatter->setTimeZone($timezone)) {
-                    $timezone = 'UTC';
-                }
-            } catch (IntlException) {
-                Log::warning("Time zone “{$timezone}” does not appear to be supported by ICU: ".intl_get_error_message());
-                $timezone = 'UTC';
-            }
-        }
-
-        $this->app->make(ConfigRepository::class)->set('app.timezone', $timezone);
-        date_default_timezone_set($timezone);
-    }
-
     private function setNamespace(): void
     {
         /**

src/Support/DateTimeHelper.php

@@ -144,7 +144,7 @@ public static function toDateTime(mixed $value, bool $assumeSystemTimeZone = fal
             return false;
         }
 
-        $defaultTimeZone = $assumeSystemTimeZone ? app()->getTimezone() : 'UTC';
+        $defaultTimeZone = $assumeSystemTimeZone ? Cms::timezone() : 'UTC';
 
         if (is_array($value)) {
             if (empty($value['datetime']) && empty($value['date']) && empty($value['time'])) {
@@ -201,7 +201,7 @@ public static function toDateTime(mixed $value, bool $assumeSystemTimeZone = fal
         }
 
         if ($setToSystemTimeZone) {
-            $dateTime->setTimezone(new DateTimeZone(app()->getTimezone()));
+            $dateTime->setTimezone(new DateTimeZone(Cms::timezone()));
         }
 
         return $dateTime;
@@ -316,7 +316,7 @@ public static function now(?DateTimeZone $timeZone = null): DateTime
     {
         if (! empty(self::$_now)) {
             $date = clone self::$_now[0];
-            $date->setTimezone($timeZone ?? new DateTimeZone(app()->getTimezone()));
+            $date->setTimezone($timeZone ?? new DateTimeZone(Cms::timezone()));
 
             return $date;
         }

src/Translation/Formatter.php

@@ -5,6 +5,7 @@
 namespace CraftCms\Cms\Translation;
 
 use Carbon\CarbonInterface;
+use CraftCms\Cms\Cms;
 use CraftCms\Cms\Support\Str;
 use DateInterval;
 use DateTime;
@@ -31,7 +32,7 @@ class Formatter
     }
 
     public string $timeZone {
-        get => $this->timeZone ?? app()->getTimezone();
+        get => $this->timeZone ?? Cms::timezone();
     }
 
     public string $defaultDateFormat = 'medium';

src/Twig/Twig.php

@@ -132,7 +132,7 @@ public function create(): Environment
         }
 
         $core = $twig->getExtension(CoreExtension::class);
-        $core->setTimezone(app()->getTimezone());
+        $core->setTimezone(Cms::timezone());
 
         event(new TwigCreated($twig, TemplateMode::get()));
 

tests/TestCase.php

@@ -6,6 +6,7 @@
 
 use Craft;
 use craft\test\TestSetup;
+use CraftCms\Cms\Cms;
 use CraftCms\Cms\Dashboard\Widgets\Widget;
 use CraftCms\Cms\Database\LaravelMigrations;
 use CraftCms\Cms\Database\Migrations\Install;
@@ -30,7 +31,6 @@
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Foundation\Testing\RefreshDatabaseState;
 use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Context;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\File;
@@ -62,8 +62,7 @@ protected function setUp(): void
         // Reset timezone to a consistent value for tests
         // This is needed because AppServiceProvider::setTimezone() runs during boot,
         // before RefreshDatabase has prepared the database, potentially reading stale data
-        Config::set('app.timezone', 'America/Los_Angeles');
-        date_default_timezone_set('America/Los_Angeles');
+        Cms::config()->timezone('America/Los_Angeles');
 
         // Tests run in Cp by default
         TemplateMode::set(TemplateMode::Cp);