use tag param to set timezone

Author: edalzell

src/Events.php

@@ -44,6 +44,8 @@ class Events
 
     private array $terms = [];
 
+    private ?string $timezone = null;
+
     public static function defaultTimezone(): string
     {
         return static::setting('timezone', config('statamic.system.display_timezone') ?? config('app.timezone', 'UTC'));
@@ -139,6 +141,13 @@ public function terms(string|array $terms): self
         return $this;
     }
 
+    public function timezone(string $timezone): self
+    {
+        $this->timezone = $timezone;
+
+        return $this;
+    }
+
     public function between(string|CarbonInterface $from, string|CarbonInterface $to): EntryCollection|LengthAwarePaginator
     {
         return $this->output(
@@ -157,6 +166,13 @@ private function output(callable $type): EntryCollection|LengthAwarePaginator
     {
         $occurrences = $this->entries()->occurrences(generator: $type);
 
+        if (! is_null($this->timezone)) {
+            $occurrences->transform(fn (Entry $occurrence) => $occurrence
+                ->setSupplement('start', $occurrence->start->setTimezone($this->timezone))
+                ->setSupplement('end', $occurrence->end->setTimezone($this->timezone))
+            );
+        }
+
         if ($this->offset) {
             $occurrences = $occurrences->slice(offset: $this->offset);
         }

src/Tags/Events.php

@@ -193,6 +193,9 @@ private function generator(): Generator
             )->when(
                 value: $this->params->bool('collapse_multi_days'),
                 callback: fn (Generator $generator) => $generator->collapseMultiDays()
+            )->when(
+                value: $this->params->get('timezone'),
+                callback: fn (Generator $generator, string $tz) => $generator->timezone(timezone: $tz)
             );
     }
 

tests/Tags/EventsTest.php

@@ -8,7 +8,7 @@
 use Statamic\Facades\Site as SiteFacade;
 use Statamic\Sites\Site;
 use Statamic\Support\Arr;
-use TransformStudios\Events\Tags\Events;
+use TransformStudios\Events\Tags\Events as EventsTag;
 
 beforeEach(function () {
     Entry::make()
@@ -24,7 +24,7 @@
             'categories' => ['one'],
         ])->save();
 
-    $this->tag = app(Events::class);
+    $this->tag = app(EventsTag::class);
 });
 
 test('can generate between occurrences', function () {
@@ -409,3 +409,21 @@
         'long' => 'Sunday',
     ]);
 });
+
+test('uses the timezone param when generating occurrences', function () {
+    Carbon::setTestNow(now()->setTimeFromTimeString('10:00'));
+
+    $this->tag
+        ->setContext([])
+        ->setParameters([
+            'collection' => 'events',
+            'from' => Carbon::now()->subDay(),
+            'timezone' => 'America/Vancouver',
+            'to' => Carbon::now()->addDays(2),
+        ]);
+
+    $occurrences = $this->tag->between();
+
+    expect($occurrences)->toHaveCount(1)
+        ->first()->start->timezone->getName()->toBe('America/Vancouver');
+});