CommandSchedulerBundle

This bundle will allow you to easily manage scheduling for Symfony's console commands (native or not) with cron expression. See Wiki for Details

Versions & Dependencies

Please read Upgrade-News for Version 6

Version 7.x has the goal to use modern Php and Symfony features and low maintenance. So only PHP >= 8.4 and Symfony ^8.0 are supported at the moment.

The following table shows the compatibilities of different versions of the bundle :

Install

When using Symfony Flex there is an installation recipe.
To use it, you have to enable contrib recipes on your project :

composer config extra.symfony.allow-contrib true
composer req dukecity/command-scheduler-bundle

Update Database

If you're using DoctrineMigrationsBundle (recommended way):

php bin/console make:migration
php bin/console doctrine:migrations:migrate

Without DoctrineMigrationsBundle:

php bin/console doctrine:schema:update --force

Install Assets

php bin/console assets:install --symlink --relative public

Secure your route

Add this line to your security config.

- { path: ^/command-scheduler, role: ROLE_ADMIN } 

Check new URL /command-scheduler/list

Features and Changelog

Please read Changelog

Screenshots

Extending the ScheduledCommand Entity

You can extend the default ScheduledCommand entity to add custom fields or behavior. The bundle uses a MappedSuperclass pattern with an interface for maximum flexibility.

Creating a Custom Entity

1. Create your custom entity extending BaseScheduledCommand:

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Dukecity\CommandSchedulerBundle\Entity\BaseScheduledCommand;

#[ORM\Entity]
#[ORM\Table(name: 'scheduled_command')]
class MyScheduledCommand extends BaseScheduledCommand
{
    #[ORM\Column(type: 'string', nullable: true)]
    private ?string $customField = null;

    public function getCustomField(): ?string
    {
        return $this->customField;
    }

    public function setCustomField(?string $customField): static
    {
        $this->customField = $customField;
        return $this;
    }
}

2. Configure the bundle to use your custom entity:

# config/packages/dukecity_command_scheduler.yaml
dukecity_command_scheduler:
    scheduled_command_class: App\Entity\MyScheduledCommand

3. Update your database schema:

php bin/console make:migration
php bin/console doctrine:migrations:migrate

Available Extension Points

• ScheduledCommandInterface - Contract for all scheduled command entities
• BaseScheduledCommand - MappedSuperclass with all base properties and methods
• ScheduledCommand - Default concrete entity (used if no custom class configured)
• ScheduledCommandFactory - Service for creating entity instances

Documentation

See the documentation here.

License

This bundle is under the MIT license. See the complete license for info.