fof / console
Register custom commands and task scheduling into Flarum
Fund package maintenance!
Open Collective
Requires
- dragonmantank/cron-expression: ^3.1.0
- flarum/core: ^0.1.0-beta.16
- illuminate/console: ^8.0
- illuminate/support: ^8.0
- symfony/process: ~5.0
README
This package is meant for extension developers and offers the ability to add task scheduling to Flarum.
Use in your extension
The real deal is using it in your own extension. Simply require it in your extension composer.json
file:
"require": { "fof/console": "^0.6" },
Now make sure the ConsoleProvider
is registered inside Flarum. There's an Extender that helps you with that, inside
your extend.php
add:
return [ new \FoF\Console\Extend\EnableConsole, // .. your code ];
Task Scheduling, cron jobs
To set a schedule, create a Service Provider which
resolves the Illuminate\Console\Scheduling\Schedule
through IoC, then use its methods to configure the schedule
for the command, see the Task Scheduling documentation.