Path
Search!
Find the Exponential Software extensions you want
ezplatform-cron
| UNIX name | Owner | Status |
|---|---|---|
| ezplatform-cron | Brookins Consulting | stable |
| Version | Compatible with |
|---|---|
| N/A | N/A |
Ibexa Cron
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!)
- options: (Optional, by default: '') Takes custom option/s in string format which are added to the command. (E.g. '--keep=0 --status=draft' for running the cleanup versions command)
Example
date_based_published.cron.publish_scheduled:
class: EzSystems\DateBasedPublisherBundle\Command\PublishScheduledCommand
tags:
- { name: console.command }
- { name: ezplatform.cron.job, schedule: '* * * * *' }
Logging run command
If you want to log outputs of commands processed by run command you have to add the monolog channel cronjob to your configuration.
Example
monolog:
channels: [...,'cronjob']
handlers:
cronjob:
bubble: false
level: info
type: stream
path: '%kernel.logs_dir%/cronjob.log'
channels: [cronjob]
COPYRIGHT
Copyright (C) 1999-2021 Ibexa AS (formerly eZ Systems AS). All rights reserved.
LICENSE
This source code is available separately under the following licenses:
A - Ibexa Business Use License Agreement (Ibexa BUL),
version 2.4 or later versions (as license terms may be updated from time to time)
Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription,
as described at: https://www.ibexa.co/product
For the full Ibexa BUL license text, please see:
- LICENSE-bul file placed in the root of this source code, or
- https://www.ibexa.co/software-information/licenses-and-agreements (latest version applies)
AND
B - GNU General Public License, version 2
Grants an copyleft open source license with ABSOLUTELY NO WARRANTY. For the full GPL license text, please see:
- LICENSE file placed in the root of this source code, or
- https://www.gnu.org/licenses/old-licenses/gpl-2.0.html