draw/cron-job

This component allows to manage cron jobs.

0.14.0 2024-10-16 15:32 UTC

Requires

• php: >=8.2
• doctrine/orm: ^2.11
• dragonmantank/cron-expression: ^3.3
• draw/core: ^0.14
• draw/messenger: ^0.14
• draw/process: ^0.14
• symfony/amqp-messenger: ^6.4.0
• symfony/console: ^6.4.0
• symfony/dependency-injection: ^6.4.0
• symfony/event-dispatcher: ^6.4.0
• symfony/messenger: ^6.4.0

Requires (Dev)

• draw/dependency-injection: ^0.14
• draw/tester: ^0.14
• nesbot/carbon: ^2.0
• phpunit/phpunit: ^11.3

MIT

• Martin Poirier Theoret

• cron
• cron job
• draw
• cronjob

README

This library is used to manage and process cron jobs from the database.

The cron are sent to a queue and processed by a worker via symfony messenger.

Configuration

The package can be enabled as follows:

NOTE: Below are the default configs which can be overwritten by your needs.

Framework extra

draw_framework_extra:
  # ...
  cron_job:
    enabled: true
    doctrine:
      orm:
        mappings:
          DrawCronJob:
            is_bundle: false
            type: attribute
            dir: ...
            prefix: Draw\Component\CronJob\Entity

NOTE: The following services are available:

• draw.cron_job.command.queue_cron_job_by_name_command: Draw\Component\CronJob\Command\QueueCronJobByNameCommand
• draw.cron_job.command.queue_due_cron_jobs_command: Draw\Component\CronJob\Command\QueueDueCronJobsCommand
• draw.cron_job.cron_job_processor: Draw\Component\CronJob\CronJobProcessor
• draw.cron_job.message_handler.execute_cron_job_message_handler: Draw\Component\CronJob\MessageHandler\ExecuteCronJobMessageHandler

Sonata integration

draw_sonata_integration:
  cron_job:
    enabled: true
    admin:
      cron_job:
        group: Cron Job
        entity_class: Draw\Component\CronJob\Entity\CronJob
        controller_class: Draw\Bundle\SonataIntegrationBundle\CronJob\Controller\CronJobController
        icon: fas fa-clock
        label: Cron Job
        pager_type: simple
        show_in_dashboard: true
        translation_domain: SonataAdminBundle
      cron_job_execution:
        group: Cron Job
        entity_class: Draw\Component\CronJob\Entity\CronJobExecution
        controller_class: Draw\Bundle\SonataIntegrationBundle\CronJob\Controller\CronJobExecutionController
        icon: null
        label: Cron Job Execution
        pager_type: simple
        show_in_dashboard: true
        translation_domain: SonataAdminBundle

Messenger

You need to configure the routing for the messenger component for the message that will be used to process the cron jobs.

framework:
  messenger:
    routing:
      Draw\Component\CronJob\Message\ExecuteCronJobMessage: 'async'

Usage

Once the package is enabled, a new admin page will be available - Cron Job. The package also provides 2 console commands:

• draw:cron-job:queue-due - it is used to process due cron jobs by their configs; it should be configured as a cron to be executed with * * * * *
• draw:cron-job:queue-by-name - it allows to manually process a cron job by its name passed as an argument