flagrow/console

Register custom commands and task scheduling into Flarum

0.4.3 2019-01-04 15:51 UTC

README

MIT license Latest Stable Version Total Downloads Join our Discord server

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": {
    "flagrow/console": "^0.5"
},

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 \Flagrow\Console\Extend\EnableConsole,
  // .. your code
];

Example implementations:

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.

Example implementations:

Security

If you discover a security vulnerability within Console, please send an email to the Flagrow team at security@flagrow.io. All security vulnerabilities will be promptly addressed.

Please include as many details as possible. You can use php flarum info to get the PHP, Flarum and extension versions installed.

Links

A Flarum package by Flagrow.