ezsystems/ezplatform-cron

Simple cron bundle for eZ Platform

Installs: 122 805

Dependents: 11

Suggesters: 0

Stars: 20

Watchers: 16

Forks: 0

Open Issues: 2

Type:ezplatform-bundle

v3.0.0-beta2 2019-06-12 07:48 UTC

README

This package exposes cron/cron package for use in eZ Platform (or just plain Symfony) via a simle command ezplatform:cron:run.

This is not a replacement for cron/cron-bundle but rather a simpler alternative to it which can more esaily grow into focusing more on eZ Platform needs in the future including e.g. support for handling cron jobs across a cluster install (separating jobs that should run on all nodes vs jobs that should only be run on one at a time and a lock system to go with it for instance).

Setup system cron

Pick your systems cron / scheduling and setup ezplatform:cron:run command to run every minute and optionally specifying category (default: default):

Example for Linux crontab (crontab -e):

* * * * * /path/to/php app/console ezplatform:cron:run [ --category=default] >/dev/null 2>&1

Setting up own cron commands

Setting up own cron jobs is as simple as tagging services for your existing Symfony Commands.

The tag takes the following arguments:

  • name: ezplatform.cron.job
  • schedule: Takes any kind of format supported by cron/cron, which mimics linux crontab format. E.g. * * * * *
  • category: (Optional, by default: default) Lets you separate cronjobs that should be run under different logic then default, e.g. infrequent jobs (NOTE: Means end user will need to setup several entries in his crontab to run all categories!)

Example

    date_based_published.cron.publish_scheduled:
        class: EzSystems\DateBasedPublisherBundle\Command\PublishScheduledCommand
        tags:
            - { name: console.command }
            - { name: ezplatform.cron.job, schedule: '* * * * *' }