Listing occurrences of event in single event template

[efc]

I can't find an easy way to list all the occurrences of a given even in the show.antlers.html template for a single event.

In other words, I'd like to be able to loop through the occurrences of just the single event that is being displayed by the template, not all the other events in the events collection.

I think this might be related to #134, but not sure. Certainly the answer to that issue does not do what I am trying to accomplish.

Is there a way to loop through the occurrences of a single event only?

[edalzell]

That's a good feature request Eric, we'll look into that soon.

[efc]

Erin, I've been working around it and I came up with this computed value approach. In my AppServiceProvider.php I have...

public function boot(): void
{
    Collection::computed('events', 'occurrences', function ($entry, $value) {
        $result = [];
        $event = EventFactory::createFromEntry($entry);
        $occurrences = $event->nextOccurrences(10);
        foreach($occurrences as $occurrence) {
            $result[] = [
                'start' => $occurrence->start,
                'end' => $occurrence->end,
                'has_end_time' => $occurrence->end ? true : false,
            ];
        }
        return $result;
     });
}

And then in my /resources/views/events/show.antlers.html entry view template I can include...

{{ occurrences }}
    <p>
        {{ start | format('Y-m-d H:i')}}
        {{ if has_end_time }}
            - {{ end | format('H:i')}}
        {{ /if }}
        {{ start | format('T')}}
    </p>
{{ /occurrences }}

The nice thing about this approach is that I don't really need to know anything about the recurrence rules, I can just display the dates. But it is still only half-baked. For example, the hard limit of 10 occurrences is probably the wrong approach. I think I will check for an end date and only use the hard limit if no end date exists. Also, the whole thing might be better off as a tag instead of a computed value. Still, I'm glad to find a way to handle this. Let me know if you see any hidden mines in this approach.

[efc]

I've made some changes and noticed a few things about the existing code today. I thought I'd note them here in case this would be helpful.

My computed value has become a bit more complex...

Collection::computed('events', 'occurrences', function ($entry, $value) {
    $result = [];
    $event = EventFactory::createFromEntry($entry);
    $limit = 0;
    if ($event->recurrence?->value() && $event->end_date == null) {
        $limit = 10;
    }
    $occurrences = $event->nextOccurrences($limit);
    foreach($occurrences as $occurrence) {
        $result[] = [
            'start' => $occurrence->start,
            'end' => $occurrence->end,
            'has_end_time' => $occurrence->has_end_time,
            'all_day' => $occurrence->all_day,
        ];
    }
    return $result;
});

This uses the recurrence to determine if there should be a limit set. The limit itself is still hardcoded (though it should probably be a config). I have also changed the has_end_time and added the all_day since those are both pertinent on the occurrence level.

Notice that the start and end here are Carbons with the specified time zone embedded in them. This is as I would expect and I like it this way. But this differs from the start and end I get from the events::upcoming tag, which are always returned in the app's timezone and must then be forced to the desired timezone with a | timezone(timezone) modifier. This feels to me like a bug in the tag, but maybe you intend it that way? In either case, these should probably both behave the same way if you do something like this in the addon.

Also note that I had to use $event->recurrence?-value() since $event->isRecurring() seems to have a bug (which I will report separately).

This all allows me to then use the following code in my view...

{{ occurrences }}
    {{ occurrence_year = start | format('Y') }}
    {{ date_format = occurrence_year != this_year ? 'l, n/j/Y' : 'l, n/j' }}
    <p class="mb-2">
        <span class="font-bold">{{ start | format(date_format) }}</span><br />
        {{ if not all_day }}
            {{ start | format('g:ia') }}
            {{ if has_end_time }}
                - {{ end | format('g:ia')}}
            {{ /if }}
            {{ start | format('T')}}
        {{ /if }}
    </p>
{{ /occurrences }}