Quelltext der Seite Calendar extended

[[Kategorie:Extensions]]

= Allgemeines =
Eine Erweiterung das Contao Kalenders. Diese Erweiterung ist entstanden, weil der Contao Kalender nicht genug Funktionalität hat. 

'''Diese Erweiterung benötigt mindestens PHP 5.3.'''

Folgende Features bietet diese Erweiterung.
# Kalender
#* Farben (Vor-/Hintergrund) für Kalender und Events
#* Ferienkalender Ja/Nein
# Events
#* Veranstaltungsort (Anschrift)
#* Kontaktperson (Link, Mail)
#* Anmeldung über Formular
#* Wiederholungen erweitert
#* Wiederholungen unregelmäßig
#* Ausnahmen für Wiederholungen 

Nach einem Update der Erweiterung kann es nötig sein, die betroffenen Events neu zu speichern.

Fehler und Anregungen können hier hinterlegt werden: https://github.com/kmielke/calendar_extended/issues

== Templates ==
Seit Contao 3.0 gibt es zusätzliche Module wie Stundenplan und Jahresübersicht, für die es euch eigene Templates gibt. Für Kalender und Events werden die Standard-Templates verwendet, die jeder selber anpassen muss. Hier kann '''ShowTemplateVars()''' helfen, um zusätzliche Variablen zu finden, die im Frostend angezeigt werden können.

= Der Kalender =
Der Kalender hat folgende neue Funktionen bekommen:

== Farben ==
'''Hintergrundfarbe'''<br/>
Die gewählte Hintergrundfarbe wird für die Darstellung der Events in der Ausgabe benutzt.

'''Vordergrundfarbe'''<br/>
Die gewählte Vordergrundfarbe wird für die Darstellung der Events in der Ausgabe benutzt.

[[Datei:Auswahl_101.png|Kalender-Auswahl|frame|center]]

Die Variabeln für die Farben müssen dann nach Wunsch in die Templates eingebaut werden.
<source lang="php">
$event['bgstyle'] = Hintergrundfarbe
$event['fgstyle'] = Vordergrundfarbe
</source>

== Ferien und Feiertage ==
'''Ferienkalender'''<br/>
Ist diese Option aktiviert, so kann dieser Kalender in den Frontend-Modulen als Ferienkalender benutzt werden. Dies hat zur Folge, dass im Frontend keine Events mehr angezeigt werden, die sich mit den Events aus dem Ferienkalender überschneiden. Dafür muss dann im FE Modul dieser Kalender als Ferienkalender ausgewählt werden.

'''Events anzeigen'''<br/>
Ist diese Option aktiviert, so werden nur bestimmte Events angezeigt, auch wenn diese sich mit den Events aus dem Ferienkalender überschneiden. Hierzu muss dann eine Option im Event selber aktiviert werden.

= Die Events =
Die Events haben folgende neue Funktionen bekommen:

'''Event immer anzeigen'''<br/>
Diese Option muss aktiviert werden, wenn das Event auch an einem Feiertag/Ferien angezeigt werden soll. Hierzu muss im Kalender die Option '''Events anzeigen''' aktiviert sein.

[[Datei:cal_ext_auswahl_005.png|Events anzeigen|frame|center]]

== Veranstaltungsort (Anschrift) ==
Hier können Informationen zum Veranstaltungsort des Events hinterlegt werden. Diese Informationen stehen dann im FE zur Verfügung.
[[Datei:Veranstaltungsort.png|Veranstaltungsort|frame|center]]

== Kontaktperson (Link, Mail) ==
Hier können Informationen zur Kontaktperson des Events hinterlegt werden. Diese Informationen stehen dann im FE zur Verfügung.
[[Datei:Kontaktinformation.png|Kontaktinformation|frame|center]]

== Anmeldung über Formular (ERST AB CONTAO 3.5.9) ==

'''Dieses Feature wurde ab der calendar_extended 3.6.0_23 komplett überarbeitet. Ab den Folgeversionen kommt dann das contao_leads und das notification_center zum Einsatz. Die Neuimplementierung ist nicht abwärtskompatibel.''' 

Diese Funktionalität setzt die Erweiterung '''contao_leads und das notification_center''' voraus. Ist '''contao_leads und das notification_center''' installiert, so kann im Event ein Formular ausgewählt werden, dass dann für die Anmeldung an diesem Event benutzt werden kann.

Damit die Daten einer Anmeldung einem Event zugeordnet werden können, muss das ein zusätzliches Feld bekommen. Es muss ein verstecktes Feld mit dem Name und dem Wert '''eventid''' im Formular angelegt werden. Soll neben der '''eventid''' auch der Name des Events gespeichert werden, muss auf die gleiche Weise das Feld '''eventtitle''' angelegt werden.

Die ersten 3 Felder müssen vorhanden sein, damit alles funktioniert. Das vierte Feld ist kein MUSS, kann aber benutzt werden, um den Titel des Events mit zu speichern. Der Name des Feldes für den Eventtitel ist egal. Wichtig ist, dass alle Felder in der '''Abfrage''' gespeichert werden.

Die Felder werden in der Tabelle ''tl_lead_data'' gespeichert.
* eventid: Zuordnung zum Event
* published: Legt fest, ob ein Teilnehmer die Anmeldung bestätigt hat. Mehr dazu weiter unten
* count: Anzahl der Teilnehmer. Standardwert ist 1. Soll den Anwendern die Möglichkeit gegeben werden, mehrere Teilnehmer anzumelden, so kann dieses Wert als normales Input Feld benutzt werden.
* course: Beispiel-Feld für den Event-Title

[[Datei:Formular.png|verstecktes Formularfeld|frame|center]]

Nun kann im Event also ein Formular ausgewählt werden. Zusätzlich ist es möglich, die minimale und maximale Anzahl der Teilnehmer festzulegen. Die Belegung wird dann auch im Event abgespeichert. Die Werte für ''aktuell'' und ''frei'' werden automatisch berechnet. Wird ein Anmeldeschluss angegeben, so wird das Formular nicht mehr ausgegeben. Wird ein Abmeldeschluss angegeben, so ist eine Abmeldung nicht mehr möglich. Wenn das Formular dann abgeschickt wird, werden die Nachrichten der gewählten Benachrichtigung entsprechend der Einstellung versendet.

[[Datei:EventAnmeldung.png|Anmeldung|frame|center]]

Damit das Formular im FE gerendert wird, muss das Template (z.B. event_full.html5) angepasst werden. '''Das Formular wird nur in der Detailansicht des Events angezeigt.''' Informationen über die Belegung können sowohl in der Detailansicht, als auch in der Listenansicht ausgegeben werden. 
<source lang="php">
    <?php if ($this->reginfo): ?>
    <div class="WhatEverCssClass">
        Teilnehmer min./max.: <?= $this->reginfo['mini'] ?>/<?= $this->reginfo['maxi'] ?>, angemeldet: <?= $this->reginfo['curr'] ?>, frei: <?= $this->reginfo['free'] ?>
    </div>
    <div class="WhatEverCssClass">
        <p><?= $this->reginfo['info'] ?></p>
    </div>
    <?php endif; ?>
    <?php if ($this->regform): ?>
    <hr>
    <div class="WhatEverCssClass">
        <?= $this->regform ?>
    </div>
    <hr>
    <?php endif; ?>
</source >

Auch im Listen Template (z.B. event_upcoming.html) kann die Information genutzt werden. 
<source lang="php">
    <?php if ($this->reginfo): ?>
    <div class="WhatEverCssClass">
        Teilnehmer min./max.: <?= $this->reginfo['mini'] ?>/<?= $this->reginfo['maxi'] ?>, angemeldet: <?= $this->reginfo['curr'] ?>, frei: <?= $this->reginfo['free'] ?>
    </div>
    <div class="WhatEverCssClass">
        <p><?= $this->reginfo['info'] ?></p>
    </div>
    <?php endif; ?>
</source >

Das Formular wird im FE solange angezeigt, bis die maximale Anzahl Teilnehmer erreicht ist. Danach wird eine Meldung angezeigt, die entsprechend konfigurierbar ist.
Standardmäßig wird im Formular die Meldung "reginfo" in ''$this->reginfo['info']'' ausgegeben. Ist die minimale Anzahl > 0, dann wird bis zum Erreichen dieser Zahl die Meldung "regmini" ausgegeben. 
<source lang="php">
$GLOBALS['TL_LANG']['MSC']['reginfo']       = 'Kurs kann wie geplant stattfinden. Bitte melden Sie sich an.';
$GLOBALS['TL_LANG']['MSC']['regmini']       = 'Minimale Teilnehmerzahl ist noch nicht erreicht. Bitte melden Sie sich an.';
$GLOBALS['TL_LANG']['MSC']['regmaxi']       = 'Maximale Teilnehmerzahl ist erreicht. Ein Anmeldung ist aktuell nicht mehr möglich.';
</source >


=== Ebene-2-Überschrift ===
Benachrichtigung

== Die Wiederholungen der Events ==
Anhand des Intervall und der Anzahl der Wiederholungen wird das Enddatum der Wiederholungen berechnet (war schon immer so), und zur Orientierung angezeigt. Ändern man die Anzahl der Wiederholungen, wird das Datum angepasst. Es kann aber nicht manuell geändert werden. Eine Liste der Wiederholungen wird in der Auswahl für die Ausnahmen gespeichert.

[[Datei:Event_wiederholen.png|Event Wiederholung|frame|center]]

Die Option "Nur an Werktage" sogt dafür, dass das Event nicht an Wochenenden angezeigt wird.

== Die Wiederholungen (erweitert) ==
In den erweiterten Wiederholungen ist es möglich Wiederholungen in einem anderen Intervall anzugeben, als es der Standard erlaubt.

Hier ist es nun möglich, zu sagen: "Ich möchte z.B. jeden dritten Mittwoch im Monat ein Event haben." Auch hier kann die Anzahl der Wiederholungen und Ausnahmen definiert werden. Die Handhabung ist hier identisch zu den normalen Wiederholungen.

[[Datei:Event_wiederholen_ext.png|Wiederholungsintervall|frame|center]]

== Wiederholungen unregelmäßig ==
Zusätzlich zu möglichen Wiederholungen, können hier unregelmäßige Wiederholungen des Events hinterlegt werden. In Kombination mit den Ausnahmen ist das ganz hilfreich, wenn man für bestimmte Konstellationen nicht mehrere Events anlegen möchte.
[[Datei:Unregelmäßig.png|Unregelmäßig|frame|center]]

== Ausnahmen für Wiederholungen ==
Für die Wiederholungen können nun Ausnahmen definiert werden. Mit der aktuellen Version gibt es 3 Varianten von Ausnahmen, die auch miteinander kombiniert werden können.

[[Datei:Ausnahmen.png|Ausnahmen|frame|center]]

*'''Datum''' - Ist das Datum der Ausnahme. Hier kann ein vorhandenes Datum gewählt werden.
*'''Aktion''' - Hier stehen drei Möglichkeiten zur Auswahl
**'''nicht anzeigen''' - Das Event wird am Ausnahmetag noch angezeigt
**'''verschieben''' - Das Event wird verschoben.
**'''CSS Class hinzufügen''' - Das Event bekommt eine CSS Class ''exception''
*'''verschieben um''' - Wurde die Aktion ''verschieben'' gewählt, so kann hier das Event um diverse Tage verschoben werden
*'''Startzeit''' - neue Startzeit für die Ausnahme
*'''Endzeit''' - neue Endzeit für die Ausnahme
*'''Grund''' - Text, der im Template ausgegeben werden kann

Die Anzahl der Wiederholungen, die im DropDown gespeichert werden kann in der Datei localconfig.php eingestellt werden.
<source lang="php">
$GLOBALS['TL_CONFIG']['tl_calendar_events']['maxRepeatExecptions'] = 365;
</source>

Der Bereich, um den ein Event verschoben werden kann ist ebenfalls konfigurierbar.
<source lang="php">
$GLOBALS['TL_CONFIG']['tl_calendar_events']['moveDays'] = 7;
</source>

Das gilt auch für die Uhrzeiten. In diesem Beispiel von 10:00 Uhr bis 22:00 im 30 Minuten Rhythmus.
<source lang="php">
$GLOBALS['TL_CONFIG']['tl_calendar_events']['moveTimes'] = '10:00|22:00|30';
</source>

Soll eine Ausnahme erstellt werden, bei der sich nur die Zeit des Events ändert, so wählt man die Aktion verschieben, verschieben um 0 Tage, und setzt die neuen Zeiten.