guikingone/scheduler-bundle

A Symfony bundle that allows to schedule and create repetitive tasks

0.10.4 2024-02-02 13:59 UTC

Requires

• php: >=8.0
• ext-json: *
• dragonmantank/cron-expression: ^3.1
• psr/log: ^1.0 || ^2.0 || ^3.0
• symfony/config: ^5.4 || ^6.0 || ^7.0
• symfony/console: ^5.4 || ^6.0 || ^7.0
• symfony/event-dispatcher: ^5.4 || ^6.0 || ^7.0
• symfony/filesystem: ^5.4 || ^6.0 || ^7.0
• symfony/finder: ^5.4 || ^6.0 || ^7.0
• symfony/lock: ^5.4 || ^6.0 || ^7.0
• symfony/options-resolver: ^5.4 || ^6.0 || ^7.0
• symfony/process: ^5.4 || ^6.0 || ^7.0
• symfony/property-access: ^5.4 || ^6.0 || ^7.0
• symfony/serializer: ^5.4 || ^6.0 || ^7.0
• symfony/stopwatch: ^5.4 || ^6.0 || ^7.0

Requires (Dev)

• ext-pcntl: *
• ext-pdo: *
• ext-redis: *
• doctrine/dbal: ^3.3.6
• doctrine/orm: ^2.8
• friendsofphp/php-cs-fixer: ^3.13
• infection/infection: ^0.26.16
• marcocesarato/php-conventional-changelog: ^1.14
• phpdocumentor/reflection-docblock: ^5.3
• phpstan/phpstan: ^1.9.8
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-doctrine: ^1.3.31
• phpstan/phpstan-phpunit: ^1.3.3
• phpstan/phpstan-strict-rules: ^1.4.4
• phpstan/phpstan-symfony: ^1.2.19
• phpunit/phpunit: ^9.5.26
• psr/cache: ^1.0 || ^2.0 || ^3.0
• rector/rector: 0.15.10
• symfony/cache: ^5.4 || ^6.0 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.0 || ^7.0
• symfony/error-handler: ^5.4 || ^6.0 || ^7.0
• symfony/framework-bundle: ^5.4 || ^6.0 || ^7.0
• symfony/http-client: ^5.4 || ^6.0 || ^7.0
• symfony/http-kernel: ~5.4.20 || ~6.0.20 || ~6.1.12 || ~6.2.6 || ^6.3.0 || ^7.0
• symfony/mercure: ^0.5.3
• symfony/messenger: ^5.4 || ^6.0 || ^7.0
• symfony/notifier: ^5.4 || ^6.0 || ^7.0
• symfony/rate-limiter: ^5.4 || ^6.0 || ^7.0

Suggests

• symfony/http-client: For dispatching http tasks and / or using external probe clients
• symfony/messenger: For dispatching tasks to queue
• symfony/notifier: For dispatching notification tasks

MIT

• Guillaume Loulier

• cron
• schedule
• Tasks
• automation
• scheduler

README

Daily runs

Code style	Infection	PHPUnit	Rector	Security	Static analysis

A Symfony bundle built to schedule/consume repetitive tasks

Main features

• External transports (Doctrine, Redis, etc)
• External configuration storage (Doctrine, Redis, etc)
• Retry / Remove / Sort policies
• Background worker
• Symfony/Messenger integration
• Mercure integration
• Fibers support

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

composer require guikingone/scheduler-bundle

Quick start

If symfony/flex is not installed, manually update the config/bundles.php:

// config/bundles.php

return [
    // ...
    SchedulerBundle\SchedulerBundle::class => ['all' => true],
];

Then configure a transport in config/packages/scheduler.yaml:

# config/packages/scheduler.yaml
scheduler_bundle:
    transport:
        dsn: 'filesystem://first_in_first_out'

Finally, it's time to create a simple task:

# config/packages/scheduler.yaml
scheduler_bundle:
    transport:
        dsn: 'filesystem://first_in_first_out'
    tasks:
        foo:
            type: 'command'
            command: 'cache:clear'
            expression: '*/5 * * * *'
            description: 'A simple cache clear task'
            options:
                env: test

When a task is configured, time to execute it, two approaches can be used:

• Adding a cron entry * * * * * cd /path-to-your-project && php bin/console scheduler:consume >> /dev/null 2>&1
• Launching the command scheduler:consume --wait in a background command

Documentation

• Usage
• Configuration
• Best practices
• Tasks
• Transports
• Lock
• Commands
• Events
• Lazy Loading
• Messenger
• HTTP entrypoint
• ExecutionPolicies
• SchedulePolicies
• Runners
• Worker
• Scheduler
• Middleware
• Probe
• Tests
• Mercure

Contributing

Want to improve this bundle?