README

What it does

The module provides paths under which cronjobs can be registered. It lists all registered cronjobs and can execute individual ones manually. The last execution, the last status and, in the event of an error, the last error message are displayed.

Features

• Clear overview of all registered CronJobs
• Easy to set timing (onInit or onReady) and delay (LazyCron)
• Individual path (endpoint) that executes the CronJobs. Configuration of a secret path segment and additional path segments (namespaces) for selected CronJobs.
• Display of the time of the last execution and any error messages
• Run CronJobs as a specific ProcessWire user
• Notes system to attach warnings or additional info to CronJobs

Install

1. Copy the files for this module to /site/modules/ProcessCronJobs/
2. In admin: Modules > Refresh. Install ProcessCronJobs.
3. Go to Setup > CronJobs
4. Copy and Install example Module (modules/ProcessCronJobs/example/ProcessCronJobsRegistration.module.example) to register your CronJobs in the __constructor() method. You can also use any other __constructor() method. It makes sense to register the CronJobs as early as possible so that they can also be executed on onInit.
5. Set up the real cron that calls the ProcessCronJobs provided endpoint.
   • Type crontab -e in your unix console
   • Add this line and save the file: * * * * * curl --silent "https://example.com/cron/" Find out more about setting up CronJobs (Wikipedia).

Install via composer

1. Execute the following command in your website root directory.

   composer require nr/processcronjobs

Register a CronJob

Simple

A simple example for registering a CronJob.

wire()->addHookBefore('ProcessCronJobs::register', function(HookEvent $event){
	/** @var ProcessCronJobs $processCronJobs */
	$processCronJobs = $event->object;
	$processCronJobs->add(
		'SuperSimpleCronJobOnDemand',
		function(CronJob $cron){ echo "Hello Cron"; },
	);
});

Delayed

This CronJob should run once a day at init.

wire()->addHookBefore('ProcessCronJobs::register', function(HookEvent $event){
	/** @var ProcessCronJobs $processCronJobs */
	$processCronJobs = $event->object;
	$processCronJobs->add(
		'MyFirstCronJobEveryDay',
		function(CronJob $cron){ echo "What a beautiful day"; },
		[
			'lazyCron' => 'LazyCron::everyDay',
			'timing' => CronJob::timingInit,
		]
	);
});

Long Running

This CronJob runs for a very long time and is called directly by a "real" CronJob so as not to block other CronJobs. The endpoint for this CronJob is https://example.com/cron/longrunning/ or https://example.com/cron/###your_secret###/longrunning/.

CronJobs that have a namespace (own path segment) cannot be delayed with LazyCron, because LazyCron can only be started by a single request. LazyCron creates a lock file and thus blocks the execution of parallel calls.

wire()->addHookBefore('ProcessCronJobs::register', function(HookEvent $event){
	/** @var ProcessCronJobs $processCronJobs */
	$processCronJobs = $event->object;
	$processCronJobs->add(
		'SuperLongRunningSpecialCronJob',
		function(CronJob $cron){ echo "I have so much work to do"; },
		[
			'timing' => CronJob::timingInit,
			'ns' => 'longrunning'
		]
	);
});

Run as a specific user

This CronJob runs as the user "cronbot". The previous user is restored after execution. If the user is not found, the CronJob is automatically disabled.

wire()->addHookBefore('ProcessCronJobs::register', function(HookEvent $event){
	/** @var ProcessCronJobs $processCronJobs */
	$processCronJobs = $event->object;
	$processCronJobs->add(
		'ImportAsSpecificUser',
		function(CronJob $cron){ echo "Running as: " . wire()->user->name; },
		[
			'user' => 'cronbot',
		]
	);
});

Process View

Configuration

Modules > Configure > ProcessCronJobs

You will find the following configuration options in the module settings:

• The trigger path, i.e. the path that triggers the CronJob processing, can be adjusted here (default: cron/).
• A secret path segment can be created that must be appended to the trigger path so that processing is started.
• Automatic processing can generally be stopped (status).
• The cache of ProcessCronJobs can be emptied. Things like the time of the last call, the status of the last call and possibly an error message are stored in the cache.

Different Callback Types

You can define callbacks in different ways:

Anonymous Function

$processCronJobs->add(
	'AnonymousFunctionCronJob',
	function(CronJob $cron){
		echo "Using anonymous function";
	}
);

Object Method

$processCronJobs->add(
	'ObjectMethodCronJob',
	[$this, 'myFunction']
);

Static Class Method

$processCronJobs->add(
	'StaticMethodCronJob',
	'\\ProcessWire\\MyClass::myStaticFunction'
);

The CronJob object