Tactician plugin that allows scheduling a command to be executed at a specific time in the future
PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
src
tests
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md update readme.md - highlight code Sep 18, 2017
SECURITY.md
composer.json
composer.lock
phpunit.xml

README.md

tactician-scheduler-plugin

Tactician plugin that allows scheduling a command to be executed at a specific time in the future

Build Status Coverage Status SensioLabsInsight Latest Stable Version Total Downloads Latest Unstable Version License

Concept

This plugin allows you to create ScheduledCommands that will be executed at a specific time in the future.

Usage

Make sure you put the SchedulerMiddleware in your CommandBus middleware chain:

// create your other middleware
$middleware[] = new SchedulerMiddleware(new FileBasedScheduler($pathWhereTheSchedulerMayKeepItsFiles) );
// create your other middleware
$commandbus = new CommandBus($middleware);

Let the command you want to schedule extend from AbstractScheduledCommand or implement the ScheduledCommandInterface. Create it and set a execution time:

class SayHappyNewYear extends AbstractScheduledCommand
{
    private $message;

    public function __construct($message)
    {
        $this->message = $message;
    }

    public function getMessage() 
    {
        return $this->message;
    }
}

$myScheduledCommand = new SayHappyNewYear('Happy New Year');
$myScheduledCommand->setTimestamp(strtotime('2016-01-01 0:00:00') );
$myCommandBus->handle($myScheduledCommand);

Create a bootstrap file that builds your Commandbus and cron the schedule execution command, for example bootstrap.php

// setup any environment you need
// create your other middleware
$middleware[] = new SchedulerMiddleware(new FileBasedScheduler($pathWhereTheSchedulerMayKeepItsFiles) );
// create your other middleware
$commandbus = new CommandBus($middleware);
return $commandbus;

Cron the scheduler at any interval you like (the more it runs, the better you can time your commands), example for once a minute

* * * * *   www-data    vendor/bin/scheduler scheduler:execute bootstrap.php

Or you can use the daemon command that ships with the package, to schedule an iteration every 10 seconds use:

vendor/bin/scheduler scheduler:daemon bootstrap.php 10

To make it stop after a minute use:

vendor/bin/scheduler scheduler:daemon bootstrap.php 10 6