goksagun / scheduler-bundle
Scheduled task bundle
Installs: 9 353
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 2
Forks: 5
Open Issues: 0
Type:symfony-bundle
Requires
- php: ^8.1
- ext-mbstring: *
- doctrine/annotations: ^1.4|^2.0
- doctrine/doctrine-bundle: ^2.0
- doctrine/orm: ^2.5
- dragonmantank/cron-expression: ^2.0|^3.0
- symfony/console: ~6.0
- symfony/framework-bundle: ~6.0
- symfony/process: ~6.0
- symfony/yaml: ~6.0
Requires (Dev)
- phpunit/phpunit: ^10.1
- dev-main
- v2.3.4
- v2.3.3
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.0
- v2.1.1
- v2.1.0
- v2.0.2
- v2.0.1
- v2.0.0
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- v0.4.8
- v0.4.7
- v0.4.6
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.1
- v0.2.0
- v0.1.15
- v0.1.14
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- v0.1.0
- v0.0.9
- v0.0.8
- v0.0.7
- v0.0.6
- v0.0.5
- v0.0.4
- v0.0.3
- v0.0.2
- v0.0.1
This package is auto-updated.
Last update: 2024-11-03 07:33:12 UTC
README
Command scheduler allows you to fluently and expressively define your
command schedule within application itself. When using the scheduler,
only a single Cron entry is needed on your server. Your task schedule is
defined in the scheduler.yaml
file or Schedule
annotation or
database
. When using the scheduler, you only need to add the following
Cron entry to your server:
* * * * * php /path-to-your-project/bin/console scheduler:run >> /dev/null 2>&1
This Cron will call the command scheduler every minute. When the
scheduler:run
command is executed, application will evaluate your
scheduled tasks and runs the tasks that are due. If you want to run
task(s) as asynchronously call the command scheduler with async flag
scheduler:run --async
.
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
$ composer require goksagun/scheduler-bundle
Applications that don't use Symfony Flex
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
$ composer require goksagun/scheduler-bundle
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the config/bundles.php
file of your project:
// config/bundles.php return [ // ... Goksagun\SchedulerBundle\SchedulerBundle::class => ['all' => true], ];
Then, add console commands to scheduler yaml file scheduler.yaml
into
config/packages
directory:
scheduler: enabled: true async: ~ log: ~ tasks: - { name: command:name argument --option, expression: "* * * * *" } - { name: another-command:name, expression: "@hourly" }
Or use attribute:
use Goksagun\SchedulerBundle\Attribute\Schedule; use Symfony\Component\Console\Command\Command; #[Schedule(name: 'command:name argument --option', expression: '*\/10 * * * *')] class AttributedCommand extends Command { // }
Or use annotation:
use Goksagun\SchedulerBundle\Annotation\Schedule; use Symfony\Component\Console\Command\Command; /** * @Schedule(name="command:name argument --option", expression="*\/10 * * * *") */ class AnnotatedCommand extends Command { // }
Or add task(s) to database, you can use scheduler:add
command to add
a task to database:
php bin/console scheduler:add 'command:name argument --option' '@daily'
If you want to edit task you can use scheduler:edit
command:
php bin/console scheduler:edit [id] 'command:name argument --no-option' '@hourly'
If you want to delete task you can use scheduler:delete
command:
php bin/console scheduler:delete [id]
If you want to list tasks you can use scheduler:list
command:
php bin/console scheduler:list
Step 4: Add the Bundle log table schema (optional)
Then, if you want to track scheduled task(s) add the bundle log table schema and store executed task(s) to db:
php bin/console doctrine:schema:update --force