Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cron/symfony-bundle
Cron integration for symfony
https://github.com/cron/symfony-bundle
hacktoberfest php symfony symfony-bundle
Last synced: 1 day ago
JSON representation
Cron integration for symfony
- Host: GitHub
- URL: https://github.com/cron/symfony-bundle
- Owner: Cron
- License: mit
- Created: 2014-03-07T19:56:51.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T19:21:26.000Z (5 months ago)
- Last Synced: 2024-12-14T20:00:44.010Z (8 days ago)
- Topics: hacktoberfest, php, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 116 KB
- Stars: 188
- Watchers: 11
- Forks: 77
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Cron Bundle
===========
[](https://packagist.org/packages/cron/cron-bundle)
[](https://github.com/cron/symfony-bundle/actions/workflows/ci.yml)
[](https://packagist.org/packages/cron/cron-bundle)
[](LICENSE)
[Cron](https://github.com/Cron/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:
```shell
composer require cron/cron-bundle
```
2. Add the bundle to your application kernel:
```php
// app/AppKernel.php
public function registerBundles()
{
// ...
$bundle = array(
// ...
new Cron\CronBundle\CronCronBundle(),
);
// ...
return $bundle;
}
```
3. Update your DB schema
```shell
bin/console make:migration
bin/console doctrine:migrations:migrate
```
4. Start using the bundle:
```shell
bin/console cron:list
bin/console cron:run
```
5. 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:
```shell
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
```shell
bin/console cron:list
```
Show a list of all jobs. Job names are show with ```[x]``` if they are enabled and ```[ ]``` otherwise.
### create
```shell
bin/console cron:create
```
Create a new job.
### delete
```shell
bin/console cron:delete _jobName_
```
Delete a job. For your own protection, the job must be disabled first.
### enable
```shell
bin/console cron:enable _jobName_
```
Enable a job.
### disable
```shell
bin/console cron:disable _jobName_
```
Disable a job.
### run
```shell
bin/console cron:run [--force] [job]
```
> which we borrowed from Symfony.
> Make sure to check out [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) as this will help you a lot.
> Please note that `--force` forces the job to be executed (even if disabled) based on the job schedule
### run now, independent of the job schedule
```shell
bin/console cron:run --schedule_now [--force] job
```
### run in non-cli contexts (i.e. [from a controller](https://symfony.com/doc/current/console/command_in_controller.html))
```shell
bin/console cron:run --script-name='bin/console'
```
### start
```shell
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
```shell
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](http://github.com/Cron/CronBundle/issues).
Requirements
------------
PHP 5.5.9 or above
Author and contributors
-----------------------
Dries De Peuter - -
See also the list of [contributors](https://github.com/Cron/CronBundle/contributors) who participated in this project.
License
-------
CronBundle is licensed under the MIT license.