Support Craft 5 Link field and CKEditor for links to Calendar Events

[mike-moreau]

What is your idea?

It would be nice to be able to link directly to a calendar event via Craft 5's link field or within CKEditor.

You would a LinkType for link fields like the one below:

<?php

namespace Solspace\Calendar\Calendar\fields\linktypes;

use craft\fields\linktypes\BaseElementLinkType;
use Solspace\Calendar\Calendar as SolspaceCalendar;
use Solspace\Calendar\Elements\Event as CalendarEventElement;

/**
 * Calendar event link type.
 */
class CalendarEvent extends BaseElementLinkType
{
    protected static function elementType(): string
    {
        return CalendarEventElement::class;
    }

    protected function availableSourceKeys(): array
    {
        $sources = [];

        $calendars = SolspaceCalendar::getInstance()->calendars->getAllCalendars();

        foreach ($calendars as $calendar) {
            $sources[] = "calendar:{$calendar->uid}";
        }

        $sources = array_values(array_unique($sources));

        if (!empty($sources)) {
            array_unshift($sources, '*');
        }

        return $sources;
    }
}

Then add an event handler for it:

use craft\events\RegisterComponentTypesEvent;
use craft\fields\Link;
use Solspace\Calendar\Calendar\fields\linktypes\CalendarEvent;

Event::on(
    Link::class,
    Link::EVENT_REGISTER_LINK_TYPES,
    function (RegisterComponentTypesEvent $event) {
        $event->types[] = CalendarEvent::class;
    }
);

The for CKEditor you'd need another event handler:

use Solspace\Calendar\Elements\Event as EventElement;
use Solspace\Calendar\Calendar as SolspaceCalendar;

            Event::on(
                CKEditorField::class,
                CKEditorField::EVENT_DEFINE_LINK_OPTIONS,
                function (DefineLinkOptionsEvent $event) {

                    $calendarSources = [];
                    $calendars = SolspaceCalendar::getInstance()->calendars->getAllCalendars();

                    foreach ($calendars as $calendar) {
                        $calendarSources[] = "calendar:{$calendar->uid}";
                    }

                    $calendarSources = array_values(array_unique($calendarSources));

                    if (!empty($calendarSources)) {
                        array_unshift($calendarSources, '*');
                    }

                    $event->linkOptions[] = [
                        'label' => 'Link to an Event',
                        'elementType' => EventElement::class,
                        'refHandle' => EventElement::refHandle(),
                        'sources' => $calendarSources,
                        'criteria' => ['uri' => ':notempty:'],
                    ];
                }
            );

This may need a bit of fine-tuning but should be close to the mark.

Calendar Version

5.x

Craft Version

5.x