Cron

MMO\core · 1 symbol · generated 30 Sep 2026

class

Cron

Cron.php:20

Manage the current user's real system crontab (via the crontab command). addJob/removeJob/

class MMO\core\Cron extends MMO\core\classes\aModule

Namespace: MMO\core
Extends: aModule
See: save all mutate the REAL crontab immediately.

$cron = Cron::Shared(); $cron->getJobs(); // e.g. ['@localhost' => [[CronExp, 'some command']]]

Index

	LOCAL_EMAIL
	jobs
	mailto
	tmpFile
	addJob($interval, $command, $email)	Add a job to the cron table.
	getJobs()	Get the list of cron jobs for the current user
	getLocalEmail()	Get local email where cron send its email if MAILTO is not defined In general these email ares stored in /var/mail/{username} and you can access theme by reading the file or call `mail`
	getTempFilename()
	hasJob($command, $index)	Find a job from its command
	reload()	Re-read the real crontab (`writeCronJobs`) into `$jobs`/`$mailto`, discarding any unsaved in-memory changes (e.g.
	removeAll()	Remove the current user's ENTIRE crontab (`crontab -r`) -- irreversible, and NOT limited to jobs added via this class.
	removeJob($command, $save)	Remove the first job with the given command from the cron tab
	save()	Write the current in-memory `$jobs` (`getJobs`) back to the real crontab (`writeJobs`).
	writeCronJobs()	Write `crontab -l` in a temporary file
	writeJobs($jobs)	Write the list of jobs returned by `getJobs()`
	__wakeup()	Allocates a fresh temp file (`$tmpFile`) and loads the current real crontab into memory (`reload`).

Constants1

LOCAL_EMAIL

const LOCAL_EMAIL = '@localhost'

See: $mailto's default: cron mails go to the local system user when no explicit MAILTO is set.

Properties3

jobs

protected array $jobs = []

Type: array

mailto

protected string $mailto

Type: string

tmpFile

protected string $tmpFile

Type: string

Methods12

addJob($interval, $command, $email)

Cron.php:127

Add a job to the cron table.

function addJob( MMO\core\helpers\CronExp|string $interval, string $command, ?string $email = null ): string

!NOTE: if you want to suppress the output of a command, use `{command} >/dev/null 2>&1`

$interval	CronExp \| string	the interval to trigger the job for
$command	string	the command to execute
$email = null	null \| string	- if null, will use current mailto variable - if string, will add mailto instruction
returns	string	the real job command written in the cron tab

getJobs()

Cron.php:93

Get the list of cron jobs for the current user

function getJobs(): array

returns

array

list<array{CronExp, string}>> the jobs by MAILTO: each [interval, command]

getLocalEmail()

Cron.php:50

Get local email where cron send its email if MAILTO is not defined In general these email ares stored in /var/mail/{username} and you can access theme by reading the file or call mail

function getLocalEmail(): string

returns

string

getTempFilename()

Cron.php:40

function getTempFilename(): string

returns string the temp file used to stage crontab reads/writes ($tmpFile).

hasJob($command, $index)

Cron.php:103

Find a job from its command

function hasJob(string $command, ?array &$index = null): bool

$command	string
$index = null	null \| array	[email, index] the index in $this->jobs
returns	bool

reload()

Cron.php:72

Re-read the real crontab (writeCronJobs) into $jobs/$mailto, discarding any unsaved in-memory changes (e.g. from addJob/removeJob before save).

function reload(): void

returns

void

removeAll()

Cron.php:64

Remove the current user's ENTIRE crontab (crontab -r) -- irreversible, and NOT limited to jobs added via this class.

function removeAll(): void

returns

void

removeJob($command, $save)

Cron.php:154

Remove the first job with the given command from the cron tab

function removeJob(string $command, bool $save = true): bool

$command	string	the command written in the cron tab (returned by addJob)
$save = true	bool
returns	bool

save()

Cron.php:182

Write the current in-memory $jobs (getJobs) back to the real crontab (writeJobs).

function save(): void

returns

void

writeCronJobs()

Cron.php:58

Write crontab -l in a temporary file

function writeCronJobs(): void

returns

void

writeJobs($jobs)

Cron.php:168

Write the list of jobs returned by getJobs()

function writeJobs(array $jobs): void

$jobs	array	[MAILTO => [[{CronExp} interval, {string} command]]]
returns	void

__wakeup()

Cron.php:34

Allocates a fresh temp file ($tmpFile) and loads the current real crontab into memory (reload).

function __wakeup(): void

returns

void

Inherited members (48)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aModule

Methods	Declared by	Description
`alert($message, $context)`	aModule	Action must be taken immediately.
`backtraces($message, $context)`	aModule	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`Configure($config)`	aModule	Merge $config into this module's configuration in the shared `Configuration`.
`critical($message, $context)`	aModule	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aModule	Detailed debug information.
`debugName()`	aModule	Human-readable identifier used as the default `{origin}` in this instance's log messages.
`DefaultConfig()`	aModule	The config a module starts from before anything loaded via `Configuration` is merged in.
`emergency($message, $context)`	aModule	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aModule	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getVerbosity()`	aModule
`info($message, $context)`	aModule	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`Instantiate($config)`	aModule	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	aModule
`log($level, $message, $context)`	aModule	Logs with an arbitrary level.
`notice($message, $context)`	aModule	Normal but significant events.
`offsetExists($key)`	aModule	\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
`offsetGet($key)`	aModule	\ArrayAccess::offsetGet -- reads a property directly, unless it has a `#[Serialize(serialize: 'methodName')]` attribute, in which case that zero-argument method is called instead (e.g.
`offsetSet($key, $value)`	aModule	\ArrayAccess::offsetSet -- sets a property directly, unless it has a `#[Serialize(unserialize: 'methodName')]` attribute, in which case that method is called with $value instead (e.g.
`offsetUnset($key)`	aModule	\ArrayAccess::offsetUnset -- equivalent to `$module[$key] = null`.
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`setVerbosity($verb)`	aModule	Set the current verbosity mask, replacing whatever it was before.
`Shared()`	aModule	Get the shared instance, creating (and configuring) it on first call.
`testVerbosity($level)`	aModule	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`traitUnshare($serialize)`	aModule	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`unserialize($data, $path, $instances)`	aModule	\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto `DefaultConfig`, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
`Unshare($serialize)`	aModule	Like `tSingleton::Unshare`, but also disconnects this module's instance from every event it was listening to (via `Event::DisconnectListeners`) before dropping it.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.
`__construct($config)`	aModule	protected constructor, so it is not possible to do `new Module(...)` called by the serialization process just before being injected with data.