Dokumentation

In dieser Dokumentation findest du alle wichtigen Informationen rund um das Plugin – von der Installation über die Konfiguration bis hin zur Nutzung und Erweiterung.

Themen

Themen:

Docs

→ Entwicklung

→ Event Model

Event Model

In diesem Beitrag erklären wir:

Event-Abfrage
Event-Datenstruktur
Weitere Methoden

Um Informationen eines Events auszulesen, kann die Model-Klasse Cevento\Models\Event verwendet werden. Diese stellt verschiedene statische Helfermethoden für Datenbankabfragen bereit.

Event-Abfrage

Ein einzelnes Event kann mit folgender Methode abgefragt werden:

$event = Cevento\Models\Event::get($event_id);

Um mehrere Events abzufragen, steht folgende Methode zur Verfügung:

$events = Cevento\Models\Event::getAll($query_args = []);

Zusätzliche Filter- und Sortierparameter können über das Array $query_args übergeben werden. Erwartet wird dabei die Standardstruktur des Parameters der Methode WP_Query::parse_query($query_args). Eine vollständige Übersicht aller möglichen Parameter findet sich in der offiziellen WordPress-Dokumentation.

Event-Datenstruktur

Events werden jeweils als assoziatives Array in folgender Struktur zurückgegeben:

Key	Typ	Beschreibung
id	Integer	Die ID des Events
title	String	Der Name des Events
description	String	Die unformatierte Beschreibung des Events
html_description	String	Die formatierte Beschreibung des Events
fullday	Boolean	Ob das Event ganztägig ist
createdAt	DateTime	Erstellungsdatum des Events
startsAt	DateTime	Startdatum und -zeit des Events
endsAt	DateTime	Enddatum und -zeit des Events
bookingEnabled	Boolean	Ob Buchungen für dieses Event im Backend genehmigt wurden. Achtung: Dies bezieht sich ausschließlich auf die Checkbox-Einstellung im Event und berücksichtigt weder freie Plätze noch den definierten Buchungszeitraum.
bookingForm	Integer, Null	Die ID des verknüpften Buchungsformulars
bookingMaxPlaces	Integer	Die maximale Anzahl verfügbarer Plätze
bookingStartsAt	DateTime	Zeitpunkt ab dem Buchungen zugelassen sind
bookingEndsAt	DateTime	Zeitpunkt ab dem keine Buchungen mehr zugelassen sind
address	String	Die Adresse des Events
addressName	String	Die Bezeichnung der Event-Adresse
coordinates	String	Die Koordinaten des Veranstaltungsorts (lat,lng)
bookingConfirmationRequired	Boolean	Ob eine Buchung durch einen Administrator bestätigt werden muss
categories	Array	Alle mit dem Event verknüpften Kategorien
url	String	Der Link zur Einzelansicht des Events
status	String	Der aktuelle Veröffentlichungsstatus des Events
dateTime	String	Formatiertes Zeitintervall des Events

Weitere Methoden

Abfragen zu Metadaten

use \Cevento\Models\Event;

// Prüft, ob ein Event in der Zukunft liegt
Event::isUpcoming($event_id): bool

// Gibt den für die Ausgabe formatierten Zeitraum eines Events zurück
Event::getDateTime($event_id): string

Abfragen zu Buchungen

use \Cevento\Models\Event;

// Prüft, ob für ein Event Buchungen aktiv sind
Event::isBookingActive($event_id): bool 

// Prüft, ob noch Plätze für das Event verfügbar sind
Event::hasPlacesAvailable($event_id): bool 

// Prüft, ob ein Event ausgebucht ist
Event::isFull($event_id): bool 

// Gibt die Anzahl der verfügbaren Plätze zurück
Event::getAvailablePlaces($event_id): int 

// Gibt den Platzstatus als formatierten String zurück
Event::getAvailablePlacesText($event_id): string

Dokumentation

Themen:

Themen:

Event Model

In diesem Beitrag erklären wir:

Event-Abfrage

Event-Datenstruktur

Weitere Methoden

Abfragen zu Metadaten

Abfragen zu Buchungen

Jetzt loslegen