Library Group: scheduler

Generated by php build/docs/rvn-docs.php. Do not edit this file by hand.

| Symbol | Kind | Summary | @return |
| --- | --- | --- | --- |
| Raven\Lib\Scheduler\Cron::runIfDue() | method | Executes the passive scheduler trigger when the current scope allows it and the throttle window expired. | void |
| Raven\Lib\Scheduler\Queue::applySchedule() | method | Flips page statuses based on published / expires schedule columns. | void |
| Raven\Lib\Scheduler\Registry::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Scheduler\Registry::addExtensionSource() | method | Marks an extension directory as having a cron provider to load. | (No @return.) |
| Raven\Lib\Scheduler\Registry::getLastRunTime() | method | Returns the Unix timestamp of the last successful run for a given job, or null if never run. | int\|null Unix timestamp of the last successful run, or null if the job has never run. |
| Raven\Lib\Scheduler\Registry::getStatus() | method | Returns a status snapshot for all registered jobs. | array<string, array{owner: string, name: string, interval: int, lastrun: int\|null, nextdue: int\|null, overdue: bool}> |
| Raven\Lib\Scheduler\Registry::jobs() | method | Returns all currently registered jobs, triggering a lazy extension load first. | array<string, array{owner: string, name: string, interval: int, run: callable}> |
| Raven\Lib\Scheduler\Registry::registerJob() | method | Registers one job directly into the scheduler. | (No @return.) |
| Raven\Lib\Scheduler\Registry::runDue() | method | Runs all jobs that are currently due and returns a per-job result map. | array<string, array{ran: bool, error: string\|null, reason: string\|null}> |

Parameter Details

Raven\Lib\Scheduler\Cron::runIfDue()

  • File: private/lib/Scheduler/Cron.php
  • Params:
  • array&lt;string, mixed&gt; $rvn Active Raven runtime container.
  • string $root Absolute project root path.
  • bool $shouldRun Whether the current request scope should trigger fallback scheduling.
  • callable(array&lt;string, mixed&gt;): array&lt;string, mixed&gt;|null $prepareRuntime Optional callback that enriches the runtime before jobs execute.

Raven\Lib\Scheduler\Queue::applySchedule()

  • File: private/lib/Scheduler/Queue.php
  • Params:
  • PDO $db Active database connection.
  • string $driver Database driver string (&#039;mysql&#039;, &#039;sqlite&#039;, &#039;pgsql&#039;).
  • string $prefix Table name prefix for this Raven installation.

Raven\Lib\Scheduler\Registry::__construct()

  • File: private/lib/Scheduler/Registry.php
  • Params:
  • string $root Project root path.

Raven\Lib\Scheduler\Registry::addExtensionSource()

  • File: private/lib/Scheduler/Registry.php
  • Params:
  • string $directoryName Extension directory name.

Raven\Lib\Scheduler\Registry::getLastRunTime()

  • File: private/lib/Scheduler/Registry.php
  • Params:
  • string $owner Owner key identifying the extension or core subsystem.
  • string $name Job name within that owner namespace.

Raven\Lib\Scheduler\Registry::getStatus()

  • File: private/lib/Scheduler/Registry.php
  • Params: (none)

Raven\Lib\Scheduler\Registry::jobs()

  • File: private/lib/Scheduler/Registry.php
  • Params: (none)

Raven\Lib\Scheduler\Registry::registerJob()

  • File: private/lib/Scheduler/Registry.php
  • Params:
  • string $owner Logical owner key (for example \core\ or an extension directory name).
  • string $name Job name slug (\^[a-z0-9][a-z0-9_-]{0,63}$\).
  • int $interval Minimum seconds between runs; must be at least 1.
  • callable $run Called with \array $context\ when the job is due.

Raven\Lib\Scheduler\Registry::runDue()

  • File: private/lib/Scheduler/Registry.php
  • Params:
  • array&lt;string, mixed&gt; $context Context passed to each job callable; must include \root\ and \rvn\.