daltonmenezes/eventscheduler

A simple event scheduler application for PHP projects

eventScheduler

, _(*1)

A simple event scheduler application for PHP projects., _(*2)

Installation

The Package is available on Packagist, you can install it using Composer., _(*3)

composer require daltonmenezes/eventscheduler

Dependencies

• PHP 5.3+

How it works?

Setting a start and finish date, you can trigger different events for each., _(*4)

The behavior you set to be triggered on the start date is defined by after() event;, _(*5)

The behavior you set to be triggered while the start date is not reached is the before() event;, _(*6)

When the finish date is reached, after() event is suspended, as well before() event too., _(*7)

The finish date is optional, if you want the after() event continues in your project execution without date limitations, simply do not set the key "finish" in your array., _(*8)

Usage

Instantiate EventScheduler\EventScheduler., _(*9)

use EventScheduler\EventScheduler;

$event = new EventScheduler();

Define a start date in your schedule, its must be an array., _(*10)

$schedule = array("start" => "18-03-2016 23:43");

The start key is for when your event must be triggered. If you want define a finish date for shutdown it, you must define a finish key in your array., _(*11)

$schedule = array(
    "start" => "18-03-2016 23:43",
    "finish" => "20-03-2020 19:13"
);

Now, call the schedule method for set your array., _(*12)

$event->schedule($schedule);

Call the before() method for set this behavior. The parameter must be a Closure. If you do not want call and define this method, it's ok. It's optional., _(*13)

$event->before(function() {
    // define here whatever you want execute as an expected behavior
});

Call the after() method for set this behavior. The parameter must be a Closure. If you do not want call and define this method, it's ok. It's optional., _(*14)

$event->after(function() {
    // define here whatever you want execute as an expected behavior
});

Call the run() method for when all is done!, _(*15)

$event->run();

Nothing more! It's simple! ;) You can read or test the example.php file at the root directory of this project., _(*16)

Problems or suggestions?

Open a Issue. :), _(*17)