Service API

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

Neighboring modules query the module’s state through a stable, read-only facade (CronjobService) instead of its internal services. Check availability first - the module may not be installed, and the class is only autoloadable when its module.php has been loaded:

<?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
}

Question	Method(s)
Is the service functional?	`isFunctional()`, `problems()` (codes: `module_disabled`, `not_migrated`, `cron_library_missing`, `tick_stale`)
Which features are enabled?	`features()` (`watch`, `pseudo_events`, `route_events`), `watchStatus()`
When did the last tick run?	`lastTick()` / `lastTickAge()` - both trigger types (marker file `data/cronjob/tick.last`)
Is a job enabled / when did it last run?	`isJobEnabled($name)`, `jobStatus($name)`, `lastRun($name)` - job names are namespaced (`<module>:<name>`)
Which events are listened for?	`listenedEvents()`, `listenersFor($event)`; catalogs: `eventCatalog()`, `pseudoEvents()`, `routeEvents()`
Actions (the only two)	`runJobNow($name)` (queued at the next tick), `pushEvent($name, $payload)` (event queue)

Contract: read-only methods never throw when the schema is missing (safe defaults), descriptions are source strings (never pre-translated), and lastRun() deliberately excludes the job output, which may contain personal data.

Self-registration

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

Other modules can advertise their scheduled jobs so they show up in the admin UI without manual registry editing. Two ways (a module may use both); both are discovered automatically on each tick, only for enabled modules:

Marker method

getCronJobs(): array on the module’s module.php class, returning the same shape. Equivalent: getModuleEvents(): array, getModuleCommands(): array.

Manifest file (recommended)

modules_v4/<module>/cron-jobs.php that returns an array of job specs:

<?php
// modules_v4/linkenhancer/cron-jobs.php
declare(strict_types=1);

return [
 [
 'name' => 'link-index',
 'title' => 'Update the link index',
 'triggers' => [
 ['type' => 'time', 'cron' => '*/30 * * * *'],
 ],
 'command_type' => 'module',
 'command' => 'modules_v4/linkenhancer/cli/build-link-index.php',
 'args' => '--limit=5000',
 ],
];

Translatable title / description literals in a manifest should be wrapped in MoreI18N::translate() (identity marker) so xgettext picks them up - translation happens at render time, never at manifest load.

Howto on wt-modules

Service API

Self-registration

Marker method

Manifest file (recommended)