Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-adamski/symfony-schedule-bundle
Bundle for Symfony simplifying operations with CRON jobs
https://github.com/m-adamski/symfony-schedule-bundle
php schedule-bundle symfony symfony-bundle
Last synced: 26 days ago
JSON representation
Bundle for Symfony simplifying operations with CRON jobs
- Host: GitHub
- URL: https://github.com/m-adamski/symfony-schedule-bundle
- Owner: m-adamski
- License: mit
- Created: 2018-02-12T10:34:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T10:22:23.000Z (9 months ago)
- Last Synced: 2024-09-30T16:40:50.248Z (about 1 month ago)
- Topics: php, schedule-bundle, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 48.8 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Schedule Bundle for Symfony
Bundle for simplifying operations with CRON jobs.
Version 2.x is no longer compatible with Symfony version 4.x. In this case, use version 1.x
## Installation
This Bundle can be installed by Composer:
```
$ composer require m-adamski/symfony-schedule-bundle
```
## How to use it?
Bundle provide functionality to manage CRON jobs by configuration from specified file.
We need to create class implementing ``Adamski\Symfony\ScheduleBundle\Model\ManagerInterface`` interface.
```(php)
namespace App\Model;
use Adamski\Symfony\ScheduleBundle\Model\ManagerInterface;
use Adamski\Symfony\ScheduleBundle\Model\Schedule;
class ScheduleManager implements ManagerInterface {
public function schedule(Schedule $schedule) {
// TODO: ..
}
}
```
Then we need to complete the configuration - create file ``config/packages/schedule.yaml`` and set path to ScheduleManager:
```(yaml)
schedule:
manager: App\Model\ScheduleManager
```
## Command schedule configuration
In function ``schedule`` we can configure CRON jobs with required expressions.
For example we want run ``app:test-command`` daily at 12:00:
```(php)
public function schedule(Schedule $schedule) {
$schedule->command("app:test-command")->dailyAt("12:00");
}
```
Schedule class provide many date-time manipulators. This functionality is inspired by Laravel Tasks Scheduling.
## Schedule Frequency Options
There are many schedules that you can assign to your task.
| Method |
| ---------------------------------------------- |
| cron($expression) |
| everyMinute() |
| everyFiveMinutes() |
| cron($expression) |
| everyMinute() |
| everyFiveMinutes() |
| everyTenMinutes() |
| everyFifteenMinutes() |
| everyThirtyMinutes() |
| hourly() |
| hourlyAt(int $offset) |
| daily() |
| at(string $time) |
| dailyAt(string $time) |
| twiceDaily(int $first = 1, int $second = 13) |
| weekdays() |
| weekends() |
| mondays() |
| tuesdays() |
| wednesdays() |
| thursdays() |
| fridays() |
| saturdays() |
| sundays() |
| weekly() |
| weeklyOn(int $day, string $time = "0:0") |
| monthly() |
| monthlyOn(int $day = 1, string $time = "0:0") |
| twiceMonthly(int $first = 1, int $second = 16) |
| quarterly() |
| yearly() |
| days($days) |
## CRON
Now it's enough to insert only one entry into crontab on server:
```
* * * * * php /path-to-project/bin/console schedule:run >> schedule.log 2>&1
```
## License
MIT