Calendarize - Flexible TYPO3 Calendar

Rendered

Wed, 20 Aug 2025 14:35:25 +0000

Classification

calendarize

Keywords

forEditors, forAdmins, forBeginners, forIntermediates

Author

Tim Lochmüller

Email

tim@fruit-lab.de

Language

en

Introduction

What does it do?

Calendarize is a flexible calendar for TYPO3. The aim of the extension is NOT the base structure of events (location, category etc.). The aim of the extension is the timely representation of ExtBase models (any kind) in a index. Further more the extension is shipped with different calendar views.

Report bugs and ideas to: https://github.com/lochmueller/calendarize

Credits

• Tim Lochmüller – typo3.fruit-lab.de / typo3blogger.de
• Max Kalus – auxnet.de
• Paul Beck - teamgeist-medien.de / blog.teamgeist-medien.de
• https://github.com/iconic/open-iconic for the icon (png / svg). Thank you!

Enter your name to the list, if your are contribute via github to the calendarize project. Thank you!

For users

Getting started

The tutorial will show you use the basic usage of the calendarize extension in TYPO3. This requires the first steps of the installation to be completed.

The event record stores information, whereas the plugin is used to render these records in the frontend.

1. Create an Event

   1. Create or select a sysfolder to store the records.

   2. In the list module choose Create a new record in the top bar. Click on Event under Calendarize - Event Management.

      
   3. Fill in the field Title.
   4. Navigate to the tab Date options and create a Calendarize configuration by clicking on Create new

   5. Fill in the field Start date with a date in the near future.

      
   6. Save and close the record.

2. Add a plugin

   1. Create or select a page for listing and showing the events.

   2. In the page module add a new content element. Under the tab Plugins choose Calendar.

      
   3. You can find the plugin settings within the tab Plugin.

   4. Select the mode List + Detail.

      
   5. Navigate to the subtab General Configuration. Fill the field Startingpoint by selecting the folder from the beginning.
   6. Save the record.

3. Check the result

   Load the page in the frontend. You should see your created event. A click on the title should show the record on the detail page.

Create recurring event with exceptions

This tutorial will show you how to create a recurring event with exceptions / excluded dates.

Plugin

Filter by categories

The listed events in a plugin can be filtered by categories. The categories can be selected in the categories tab of the content element (not in the plugin options) or in the Plugin Configuration.

Category conjunction

New in version 13

It is possible to define how multiple categories are handled. If the event requires at least one (OR) or all (AND) categories to be displayed.

categoryConjunction

categoryConjunction

type

string

Default

or

Scope

Plugin

The category conjunction defines if and how the categories are treated. If no category is configured, no filter is applied (all events are shown).

[all] (Don't care, show all)

There is no restriction based on categories, even if categories are defined.

[or] (Show items with selected categories (OR))

All event records which belong to at least one of the selected categories are shown.

[and] (Show items with selected categories (AND))

All event records which belong to all selected categories are shown.

For administrators

Installation

This is the installation process of the extension:

1. Install the extension with the extension manager or composer

   composer req lochmueller/calendarize

   Copied!

2. Include the static TypoScript configuration Calendarize (calendarize) in your TypoScript template

   
3. Create a new folder in your page tree, where you create events and related records like configuration groups.
4. Depending on your needs, create a TYPO3 page for event listing, event details and registration.
5. Include the plugin “Calendarize” and configure the plugin settings.
6. Configure extension TypoScript settings depending in your constant editor on your needs.

Configuration

The configuration of the calendarize is very straightforward. Please install the extension and include the Static Extension TypoScript to your TypoScript. After that, the extension is working in the frontend.

Via the constant editor, you can adapt template path and feed options. There are also options for date and time formats and limits for browesable views like the month view. Please check the constant editor for all options.

The last step is, place the plugins on your pages. The view is always related to the configured PIDs. That means, if you create a month view and set a detailPid, the template will render detail links to events. If you leave the detailPid empty and select the monthPid, no events are in the output and the month view is a "small month view". Just try same combinations :)

XML Sitemap for TYPO3

The sitemap includes links to all indices.

plugin.tx_seo {
  config {
    xmlSitemap {
      sitemaps {
        ext_calendarize {
          provider = TYPO3\CMS\Seo\XmlSitemap\RecordsXmlSitemapDataProvider
          config {
            table = tx_calendarize_domain_model_index
            pid = <page id(s) containing records>
            url {
              pageId = {$plugin.tx_calendarize.settings.defaultDetailPid}
              fieldToParameterMap {
                uid = tx_calendarize_calendar[index]
              }
              additionalGetParameters {
                tx_calendarize_calendar.controller = Calendar
                tx_calendarize_calendar.action = detail
              }
              useCacheHash = 1
            }
          }
        }
      }
    }
  }
}

Breadcrumb menu

To add the calendarize link to the breadcrumb use this user function

[traverse(request?.getQueryParams(), 'tx_calendarize_calendar/index') > 0]
lib.myBreadcrumbMenu.999 = USER
lib.myBreadcrumbMenu.999.userFunc = HDNET\Calendarize\Service\BreadcrumbService->generate
lib.myBreadcrumbMenu.999.doNotLinkIt = 1
lib.myBreadcrumbMenu.999.wrap = <li>|</li>
[end]

Scheduler

There is a scheduler command controller for re-indexing the current event structures. This is only a helper scheduler task, if there are external processes that create new events without triggering the index. It is recommended to configure the scheduler task (command controller) to run every night.

Import ICS / ICal Calendar

An external ICS calendar can be imported with a scheduler task. For this the scheduler task creates default events on the given pid. If an event already exists (determined by UID inside importId) on ANY pid, the event only gets updated. For your own events implement the ImportSingleIcalEventListener.

1. Add a new Scheduler Task
2. Select the class Execute console commands
3. Select Frequency for the execution
4. Go to section Schedulable Command. Save and reopen to define command arguments at the bottom.
5. Select calendarize:import (press save)
6. Select the options you want to execute the queue with, it's important to check the checkboxes and not only fill in the values.

Remove outdated events

Outdated events can either be hidden or removed with a scheduler task.

The events are determined by looking at the index, where the end date has to be older than the waitingPeriod (relative to today). This must be true for all indices of a single event. This task also supports custom events.

1. Add a new Scheduler Task
2. Select the class Execute console commands
3. Select Frequency for the execution
4. Go to section Schedulable Command. Save and reopen to define command arguments at the bottom.
5. Select calendarize:cleanup (press save)
6. Select the options you want to execute the queue with.

URL Rewrite / Speaking URLs

An introduction and a reference for configuration can be found in the official documentation.

imports:
  - { resource: "EXT:calendarize/Configuration/Yaml/RouteEnhancers.yaml" }

Linkhandler

With a proper configuration of linkhandler function you can select events in Link wizards and RTE. Details at https://usetypo3.com/linkhandler.html This configuration is enabled by default.

TCEMAIN {
  linkHandler {
    tx_calendarize_domain_model_event {
      handler = TYPO3\CMS\Backend\LinkHandler\RecordLinkHandler
      label = Events
      configuration {
        table = tx_calendarize_domain_model_event
        storagePid = xxx
        hidePageTree = 1
      }
      scanAfter = page
    }
  }
}

Migration

Migration from cal to calendarize

This will help you to migrate data from cal to calendarize.

# Run using the identifier 'calendarize_calMigration'
./vendor/bin/typo3 upgrade:run calendarize_calMigration

Workspaces

EXT:calendarize support Workspaces since version v11. Because of the "special handling" of the index calculation some words for this...

Data processing

Language menu on calendarize detail pages

If a language menu is rendered on a detail page and the languages are configured to use a strict mode, the following snippet helps you to setup a proper menu. If no translation exists, the property available is set to false - just as if the current page is not translated.

20 = TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor
20 {
  languages = auto
  as = languageNavigation
}
21 = HDNET\Calendarize\DataProcessing\DisableLanguageMenuProcessor
21 {
  menus = languageNavigation
}

For developers

Own events

The concept of the calendarize extension is the creation of own models and tables that should be part of the calendar output.

$configuration = [
    // Unique Key for the register (e.g. you Extension Key + "Event")
    'uniqueRegisterKey' => 'MyEvent',
    // Title for your events (this is shown in the FlexForm configuration of the Plugins)
    'title'             => 'My Event',
    // Name of your model
    'modelName'         => \HDNET\MyExtension\Domain\Model\MyEvent::class,
    // Partials identifier (HTML) for your event (in most cases unique)
    'partialIdentifier' => 'MyEvent',
    // Table name of your event table
    'tableName'         => 'tx_myextension_domain_model_myevent',
    // If true, your event requires at least one event configuration
    'required'          => true,

    // [OPTIONAL] All classNames used for the extended models
    'subClasses'        => array of classnames,
    // [OPTIONAL] Field name of the configurations, default is 'calendarize' (recommended)
    'fieldName'         => 'calendarize'
];

$configuration = [...];
\HDNET\Calendarize\Register::extLocalconf($configuration);

\HDNET\Calendarize\Register::createTcaConfiguration($configuration);

$GLOBALS['TCA']['tx_myextension_domain_model_myevent']['columns']['calendarize_info']['config']['parameters']['items'] = 25;

Features

Your own events can use same features directly of the calendarize integration. The features are in the folder EXT:calendarize/Classes/Features/ The following features are currelty in the calendarize extension:

• BookingInterface - The event is bookable by the internal booking process
• FeedInterface - The event is rendered in the different Feeds like Atom & RSS
• KeSearchIndexInterface - The event is indexed via the calendarize default indexer in your ke_search index
• SpeakingUrlInterface - The event is used to generate a base slug for the indices

Speaking URLs - Slugs

A slug is a unique name for an resource. The index has an slug field for all indices and can be used to map a "speaking URL" segment to an index. Since an event can produce multiple indices, we need an extra logic to generate unique slugs for them.

{1:base-slug}-{2?:slug-suffix}-{3?:regular-core-conflict-counter}

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\EventListener;

use HDNET\Calendarize\Event\SlugSuffixGenerationEvent;

final class AddEventTimeSlugListener
{
    public function __invoke(SlugSuffixGenerationEvent $event): void
    {
        // Optional: some additional checks, e.g. based on Model or page id (pid)
        // Get the start_time (seconds since day start) from the record
        $startTime = $event->getRecord()['start_time'];
        // Add to the existing slug (e.g. test-20201103) the current time (17:15)
        // resulting in test-20201103-1715
        $newSlug = $event->getSlug() . '-' . date('Hi', $startTime);
        // Update the slug
        $event->setSlug($newSlug);
    }
}

services:
  # ...
  MyVendor\MyExtension\EventListener\AddEventTimeSlugListener:
    tags:
      - name: event.listener
        identifier: 'addEventTimeSlug'

Bookings

The extension only provides interfaces for the booking system and does not process or store the submitted data. This is up to custom extensions.

TypoScript

You can render every EXT:calendarize view also directly with TypoScript. The example below renders a single event into the TS PAGE object. Please replace the markers with the right values:

page.9999 =< tt_content.list.20.calendarize_calendar
page.9999 {
  switchableControllerActions {
    Calendar {
      1 = single
    }
  }

  settings < plugin.tx_calendarize.settings
  settings {
    # Base on the event configuration table. CSV
    singleItems = ###EVENT_TABLE_NAME###_###EVENT_UID###
    # Note: perhaps also other Event configurations
    configuration = Event
  }
  persistence.storagePid = ###YOUR_STORAGE_FOLDER###
}

PageTSConfig

You can enable the generation of a preview link. Please configure the regular "detail" page of the indeces and link to the page including the "extensionConfiguration" parameter. EXT:calendarize will redirect you to the next index entry (to the last, if there is no future entry).

TCEMAIN.preview {
  tx_calendarize_domain_model_event {
    # Your ID with the detail PID here
    previewPageId = 22
    useDefaultLanguageRecord = 0
    fieldToParameterMap {
      uid = tx_calendarize_calendar[event]
    }
    additionalGetParameters {
      # Change this to your EXT:calendarize event
      tx_calendarize_calendar.extensionConfiguration = Event
      tx_calendarize_calendar.action = detail
      tx_calendarize_calendar.controller = Calendar
    }
  }
}

Templates

Changing paths of the template

Please do never change templates directly in the resources folder of the extensions, since your changes will get overwritten by extension updates.

Configure your TypoScript setup like shown below:

plugin.tx_calendarize {
  view {
    templateRootPaths {
      150 = your/new/path/
    }
    partialRootPaths {
      150 = your/new/path/
    }
    layoutRootPaths {
      150 = your/new/path/
    }
  }
}

Doing so, you can just override single files from the original templates. The calendarize templates are always the fallback (position 50). Alternatively you can change the constants:

plugin.tx_calendarize.view.templateRootPath
plugin.tx_calendarize.view.partialRootPath
plugin.tx_calendarize.view.layoutRootPath

Theses constants are used at position 100 in the TS setup of the calendarize extension.

Snippets

Get the event title of the current page (e.g. for Breadcrumb navigations):

lib.eventTitle = CONTENT
lib.eventTitle {
  table = tx_calendarize_domain_model_event
  select {
    # YOUR Staorge PID here
    pidInList = XXXXXX
    selectFields = tx_calendarize_domain_model_event.*
    join = tx_calendarize_domain_model_index ON tx_calendarize_domain_model_event.uid = tx_calendarize_domain_model_index.foreign_uid AND tx_calendarize_domain_model_index.foreign_table="tx_calendarize_domain_model_event"
    where.data = GP:tx_calendarize_calendar|index
    where.intval = 1
    where.wrap = tx_calendarize_domain_model_index.uid=|
  }
  renderObj = TEXT
  renderObj.field = title
  renderObj.htmlSpecialChars = 1
}
page.1000 < lib.eventTitle
page.1000.wrap = <h3>|</h3>

Known problems

1. The configuration record has starttime, endtime and hidden attributes. This values control the index building process. By concept the index is built just once (on save). So: If you use this field, please add the scheduler task in a short-term interval to get the right index records.

Reference

Extension Configuration

Some general settings can be configured in the Extension Configuration.

1. Go to Admin Tools > Settings > Extension Configuration
2. Choose calendarize

The settings are described here in detail:

ChangeLog

There is no separated change list. Please take a look into: https://github.com/lochmueller/calendarize/commits/master

Configuration

tbd.

Configuration Group

tbd.

Event

tbd.