This bundle it's a fork from 'valentinmari/cron-bundle', original code by Valentin Mari.
- Download CronBundle using composer
- Enable the Bundle, if required
- Define cron jobs in your config
Add CronBundle by running the command:
$ composer require psf1/cron-bundleComposer will install the bundle to your project's vendor/psf1 directory.
Edit your .env file and set the LOCK_DSN value.
# /.env.local
LOCK_DSN=flock
If you are using Flex this step it's not required.
Enable the bundle in the kernel:
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new CronBundle\CronBundle(),
);
}Your site is ready to run cron jobs. Now, write them in a new file named
cron.yml in your config folder.
#config/packages/cron.yaml
# Cron jobs.
cron:
jobs:
- { name: 'Test_job_1', format: '*/1 * * * *', service: 'App\Cron\TestJob1' }
- { name: 'Test_job_2', format: '*/1 * * * *', service: 'App\Cron\TestJob2' }
# Uncomment to execute jobs after each user request.
# run_on_request: trueThe format is like Cron, from Unix. You must define a job class, that must
implement JobInterface and redefine the run() method.
Inside run() you can put your Job and do anything you want. You can inject things
in your job class too.
// src/Cron/CacheClearCron.php
namespace App\Cron;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\HttpKernel\KernelInterface;
use VM\Cron\JobInterface;
/**
* Run cache clear job.
*/
class CacheClearCron implements JobInterface
{
protected ?Application $application;
/**
* @param KernelInterface $kernel
*/
public function __construct(KernelInterface $kernel)
{
$this->application = new Application($kernel);
$this->application->setAutoExit(false);
}
/**
* Execute job.
*
* @return void
*
* @throws \Exception
*/
public function run(): void
{
$input = new ArrayInput([
'command' => 'cache:clear',
]);
$output = new NullOutput();
$this->application->run($input, $output);
}
}This bundle allows two work methods.
- Run cron jobs in each request, if it's the time. Note that you must define job format with enough time to not duplicate executions.
- Run cron jobs by console command.
- cron:job:list: List all defined cron jobs with status.
- cron:job:run: Run cron jobs.