Service API

Mon, 01 Jan 0001 00:00:00 +0000

Benachbarte Module fragen den Status des Moduls über eine stabile, schreibgeschützte Schnittstelle (CronjobService) ab, anstatt auf dessen interne Dienste zurückzugreifen. Überprüfen Sie zunächst die Verfügbarkeit – das Modul ist möglicherweise nicht installiert, und die Klasse kann nur automatisch geladen werden, wenn die Datei module.php geladen wurde:

<?php
use Schwendinger\Webtrees\Module\Cronjob\Services\CronjobService;

if (class_exists(CronjobService::class) && CronjobService::isFunctional()) {
 $status = CronjobService::jobStatus('mymodule:backup'); // null = unknown job
 $age = CronjobService::lastTickAge(); // seconds since last tick
 $listened = CronjobService::listenedEvents(); // event name => job names
}

Frage	Methode(n)
Ist der Dienst funktionsfähig?	`isFunctional()`, `problems()` (Codes: `module_disabled`, `not_migrated`, `cron_library_missing`, `tick_stale`)
Welche Funktionen sind aktiviert?	`features()` (`watch`, `pseudo_events`, `route_events`), `watchStatus()`
Wann wurde der letzte Tick ausgeführt?	`lastTick()` / `lastTickAge()` – beide Trigger-Typen (Marker-Datei `data/cronjob/tick.last`)
Ist ein Job aktiviert / wann wurde er zuletzt ausgeführt?	`isJobEnabled($name)`, `jobStatus($name)`, `lastRun($name)` – Jobnamen sind mit einem Namespace versehen (`<Modul>:<Name>`)
Auf welche Ereignisse wird gewartet?	`listenedEvents()`, `listenersFor($event)`; Kataloge: `eventCatalog()`, `pseudoEvents()`, `routeEvents()`
Aktionen (die einzigen beiden)	`runJobNow($name)` (wird beim nächsten Tick in die Warteschlange gestellt), `pushEvent($name, $payload)` (Ereigniswarteschlange)

Vertrag: Schreibgeschützte Methoden lösen niemals einen Fehler aus, wenn das Schema fehlt (sichere Standardwerte), Beschreibungen sind Quelltext-Strings (werden niemals vorab übersetzt), und lastRun() schließt bewusst die Job-Ausgabe aus, da diese personenbezogene Daten enthalten kann.

Selbst-Registrierung

Mon, 01 Jan 0001 00:00:00 +0000

Andere Module können ihre geplanten Jobs anbieten, damit sie in der Admin-UI erscheinen, ohne dass jemand die Registry manuell editiert. Dazu können zwei Wege beschritten werden (ein Modul kann beide verwenden) - beide werden automatisch bei jedem Tick entdeckt, wobei dies nur für aktivierte Module gilt:

Marker-Methode

getCronJobs(): array in der Modul-module.php -Klasse, die dasselbe Format zurückgibt. Entsprechend: getModuleEvents(): array, getModuleCommands(): array.

Manifest-Datei (empfohlen)

Bereitstellung einer Datei im Modulverzeichnis (modules_v4/<module>/cron-jobs.php), die ein Array von Job-Spezifikationen zurückgibt:

Howto on wt-modules

Service API

Selbst-Registrierung

Marker-Methode

Manifest-Datei (empfohlen)