effiana/cron-bundle

Symfony cron

2.2.19 2020-03-03 11:31 UTC

Requires

• php: ^7.2
• doctrine/data-fixtures: ^1.3
• doctrine/doctrine-bundle: *
• doctrine/doctrine-migrations-bundle: ^1.3 | ^2.1
• doctrine/orm: *
• effiana/cron: ^2.0
• effiana/migration-bundle: dev-master
• symfony/framework-bundle: ^4.2 | ^5.0

Requires (Dev)

• symfony/phpunit-bridge: *

MIT

• Dominik Labudzinski
• Dries De Peuter

README

Cron integration for symfony.

Installation

Installing this bundle can be done through these simple steps:

1. Add the bundle to your project as a composer dependency:

composer require effiana/cron-bundle

1. Add the bundle to your application kernel:

// config/bundles.php
Effiana\CronBundle\EffianaCronBundle::class => ['all' => true],

1. Update your DB schema

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

OR

bin/console effiana:migration:load --force

1. Start using the bundle:

bin/console cron:list
bin/console cron:run

1. To run your cron jobs automatically, add the following line to your (or whomever's) crontab:

* * * * * /path/to/symfony/install/app/console cron:run 1>> /dev/null 2>&1

OR If you don't have a dedicated cron daemon (e.g. in Heroku), you can use:

bin/console cron:start # will run in background mode, use --blocking to run in foreground
bin/console cron:stop # will stop the background cron daemon

Available commands

list

bin/console cron:list

Show a list of all jobs. Job names are show with [x] if they are enabled and [ ] otherwise.

create

bin/console cron:create

Create a new job.

delete

bin/console cron:delete _jobName_

Delete a job. For your own protection, the job must be disabled first.

enable

bin/console cron:enable _jobName_

Enable a job.

disable

bin/console cron:disable _jobName_

Disable a job.

run

bin/console cron:run [--force] [job]

which we borrowed from Symfony. Make sure to check out php-cs-fixer as this will help you a lot.

start

bin/console cron:start [--blocking]

Start the cron as a daemon. By default it forks itself to the background and suppresses any output. The --blocking option will keep it in the foreground and will display output. This is useful when you don't have a dedicated cron daemon (e.g. on Heroku).

stop

bin/console cron:stop

Stops the background cron daemon started with cron:start. This is not applicable when the daemon was started with --blocking.

If you would like to help, take a look at the list of issues.

Requirements

PHP 7.2 or above

Author and contributors

Dries De Peuter - [e-mail] - http://nousefreak.be

See also the list of contributors who participated in this project.

License

CronBundle is licensed under the MIT license.