Download the PHP package samuelheer/contao-churchtools-bundle without Composer

On this page you can find all versions of the php package samuelheer/contao-churchtools-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package contao-churchtools-bundle

maintained license Contao 5.7 PHP 8.3

ChurchTools für Contao

Bringt Termine samt Flyer und Personen aus ChurchTools auf eine Contao-Website - ohne die Daten doppelt zu pflegen.

Kompatibel mit Contao 5.7 LTS und PHP ^8.3. Ausschließlich Twig-Templates, damit der Wechsel auf Contao 6 nichts kostet. Verifiziert gegen ChurchTools 3.135.

Funktionen

Was das Bundle nicht tut: Es baut nichts nach, was ChurchTools bereits kann. E-Mail-Versand, Routinen, Follow-ups und Anmeldelogik bleiben dort.

Installation

Alternativ über den Contao Manager nach samuelheer/contao-churchtools-bundle suchen.

Einrichtung

1. Dienstkonto in ChurchTools

Eine eigene Person mit eigener Berechtigungsgruppe anlegen, die nur Leserechte auf die freizugebenden Kalender und Gruppen hat, und dafür unter Persönliche Einstellungen → Logintoken ein Token erzeugen.

Kein persönliches Token verwenden. Es hängt an einem Menschen, stirbt mit dessen Konto und schreibt jede Änderung im ChurchTools-Log auf dessen Namen.

2. Token in die Umgebung

Das Token wird nie in der Datenbank gespeichert - im Backend steht nur der Name der Variablen. So landet es weder in einem Datenbank-Backup noch in einem Export.

3. Verbindung anlegen

Backend → System → ChurchTools-Verbindungen

Feld Bedeutung
Bezeichnung Name der Gemeinde bzw. Instanz
Adresse Basis-URL, z. B. https://example.church.tools
Name der Umgebungsvariablen z. B. CHURCHTOOLS_TOKEN_MAIN - nicht das Token selbst
Ordner für Bilder Zielordner für importierte Flyer, z. B. files/gemeinde/churchtools
Freigabegruppe für Personen ID der Gruppe, die entscheidet, wer auf der Website erscheinen darf
Freigabegruppe für Bilder optional. Leer: Das ChurchTools-Profilfoto erscheint bei jeder freigegebenen Person. Mit Gruppe: nur bei deren Mitgliedern
Freigegebene Personenfelder Welche Felder ChurchTools überhaupt verlassen
Erlaubte E-Mail-Domains z. B. etg-scheppach.de - dann erscheint nur eine Gemeinde-Adresse (auch eine weitere, nicht die Standardadresse), private nie. Leer: Standardadresse

Die Übersicht zeigt an, ob das Token in der Umgebung gefunden wurde. Fehlt es, steht das dort - statt dass der Abgleich stillschweigend nichts tut.

Empfehlung: Freigaben als Einwilligungsgruppen zum Selbsteintragen

Freigabe- und Bildfreigabegruppe sind Einwilligungen. Am einfachsten pflegen die Personen sie selbst:

Einstellung der Gruppe Wert
Sichtbarkeit intern (in App und Web auffindbar)
Offen für Anmeldungen / automatisch aufnehmen an / an - der Eintritt ist die Einwilligung
Anmelde-Überschrift der Einwilligungstext (was, wo, freiwillig, Widerruf durch Austritt)
Rolle der Teilnehmer ohne „Teilnehmer sehen" - niemand sieht, wer sonst eingewilligt hat

Eintrittsdatum und Protokoll belegen die Einwilligung. Alte Einwilligungsgruppen nicht löschen, sondern beenden - sonst geht das Eintrittsdatum als Nachweis verloren.

Ein selbst bearbeitbares Personenfeld ist keine Alternative, wenn die Einwilligung vor anderen verborgen sein soll: ChurchTools-Sicherheitsstufen sind eine Treppe. Was die Person selbst bearbeiten darf, liegt unterhalb dessen, was etwa Gruppenmitglieder sehen, sobald diese mehr als nur eigene Felder sehen sollen (z. B. den Geburtstag).

4. Website zuordnen

In den Seiteneinstellungen der Startseite die Verbindung auswählen. Sie gilt für alle Personen-Elemente und Insert-Tags dieser Website. Am einzelnen Element ist die Instanz bewusst nicht wählbar, damit kein Element versehentlich Personen einer fremden Gemeinde anzeigt.

5. Kalender zuordnen

Einen Contao-Kalender öffnen, Verbindung wählen, speichern, dann die gewünschten ChurchTools-Kalender ankreuzen.

Einstellung Bedeutung
ChurchTools-Verbindung Aus welcher Instanz die Termine kommen
ChurchTools-Kalender Welche Kalender übernommen werden (Liste kommt aus der API)
Abgleich-Intervall Stündlich, täglich oder nur manuell
Termin-Link statt Detailseite Ist am Termin ein Link hinterlegt, führt der Titel direkt dorthin

Wichtig: Das Merkmal „öffentlich" am ChurchTools-Kalender taugt nicht als Filter - auch Putzpläne, Sitzungen und private Belegungen stehen dort auf öffentlich. Deshalb wird hier ausdrücklich ausgewählt.

Ein zugeordneter Kalender gehört ab dann dem Abgleich: Seine Termine sind im Backend schreibgeschützt, weil der nächste Lauf Handarbeit sonst stillschweigend überschreiben würde.

Abgleich

Läuft automatisch über Contaos Cron, je Kalender nach dessen Intervall. Zusätzlich gibt es in der Kalenderliste die Schaltfläche „Jetzt abgleichen".

Auf der Konsole:

Was der Abgleich tut

Grenzen

Personen anzeigen

Insert-Tags

Inhaltselement „Person"

Eine Rolle in einer Gruppe und/oder eine feste Person, beides kombinierbar:

Berücksichtigt werden nur aktive Mitgliedschaften - Wartende, Angefragte und Ausgeschiedene erscheinen weder über die Rolle noch in der Freigabegruppe.

Darstellungen: card, inline, contact, list. Die Templates liegen unter @Contao/churchtools/person_*.html.twig und lassen sich im Projekt überschreiben.

Datenschutz

Das Bundle ist hier absichtlich streng:

Ausfallverhalten

Ist ChurchTools nicht erreichbar, bleibt die Website vollständig: Termine liegen ohnehin in der Contao-Datenbank, Personen kommen aus einem unbefristet abgelegten letzten guten Stand. Im Frontend erscheint keine Fehlermeldung.

Fehlersuche

Symptom Ursache und Lösung
Übersicht meldet „Umgebungsvariable fehlt" Die in der Verbindung genannte Variable ist nicht gesetzt. Nach dem Eintragen in .env.local den Cache leeren.
Abgleich meldet „ChurchTools ist nicht erreichbar" Basis-URL prüfen (ohne abschließenden Schrägstrich) und ob das Token noch gültig ist. churchtools:person zeigt beides an.
Kalenderliste im Backend bleibt leer Verbindung wählen und speichern - die Liste wird erst danach von der API geholt.
Termine kommen, aber ohne Flyer Hat der Termin in ChurchTools ein Bild? Der Bericht des Abgleichs nennt die Ursache je Termin.
Person erscheint nicht auf der Website vendor/bin/contao-console churchtools:person <ID> - meist fehlt der Eintrag in der Freigabegruppe.
Person erscheint, aber ohne Bild In ChurchTools ist kein Profilfoto hinterlegt, oder - falls konfiguriert - die Person steht nicht in der Bildfreigabegruppe. churchtools:person <ID> nennt den Grund.
Änderungen am Termin verschwinden wieder Der Kalender ist einer Verbindung zugeordnet und gehört dem Abgleich. Termine in ChurchTools bearbeiten.
Eigenes Template greift nicht Nach dem Anlegen cache:clear und cache:warmup - die Twig-Hierarchie wird nur beim Warmup neu gebaut.

Befehle

Befehl Zweck
churchtools:sync Termine abgleichen, mit --dry-run, --from, --to
churchtools:person <ID> Prüft Freigabe und zeigt, welche Felder ausgeliefert würden
churchtools:person --search=<Name> Personensuche wie im Backend-Auswahlfeld
churchtools:person --group=<ID> [--role=<ID>] Löst eine Gruppe bzw. Rolle auf

Weiterentwicklung

Designentscheidungen, Architektur und die Fallstricke aus dem Bau stehen in docs/entwicklung.md - lesenswert, bevor man etwas ändert.

Lizenz

LGPL-3.0-or-later


All versions of contao-churchtools-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
contao/core-bundle Version ^5.7
contao/calendar-bundle Version ^5.7
symfony/http-client Version ^6.4 || ^7.0
symfony/cache Version ^6.4 || ^7.0
symfony/messenger Version ^6.4 || ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package samuelheer/contao-churchtools-bundle contains the following files

Loading the files please wait ...