Timer

Installation

Get the package:

$ composer require khazl/timer

Install the package in your laravel app:

$ php artisan timer:install
$ php artisan migrate

Run sanity commands:

$ php artisan timer:update
$ php artisan timer:clear

It's highly recommended adding this command to your scheduler.

Once per day: timer:clear
Often as possible: timer:update

IMPORTANT: Timers can be done, also if they are not already flagged as done in the database. Always calculate the status of a timer on runtime. Use the method calculateTimerStatusByTimer for this.

Usage

You can use this lib via dependency injection or his facade.

public function DepInj(TimerServiceInterface $timerService)
{
    $timerService->createTimer(...);
}

// or

public function NoDepInj()
{
    Timer::createTimer(...);
}

Create timer

/*
 * - Creates a timer for user with id 1
 * - Times runs from now on for 60 seconds
 */
Timer::createTimer(new \DateTime(), new \DateInterval('PT60S'), 'User', '1');

You can also create a Timer with a payload:

Timer::createTimer(new \DateTime(), new \DateInterval('PT60S'), 'User', '1', [
    'type' => 'timeout',
    'reason' => 'Violate the terms of use'
]);

Timer::createTimer(new \DateTime(), new \DateInterval('P7D'), 'Invoice', '125', [
    'kind' => 'reminder',
    'channel' => 'sms'
]);

It's completely up to you, what information you want to pass as payload.
Create a payload schema that fits your needs.

Get timers by owner

/*
 * Gets all timers for user with id 1 which are not flagged as done or canceled
 */
Timer::getTimersByOwner('User', '1');

/*
 * Gets all timers for user with id 1 ALSO the ones flagged as done or canceled
 */
Timer::getTimersByOwner('User', '1', false);

Returns a Collection of Timer.

Calculate the actual status of a timer

$timers = Timer::getTimersByOwner('User', 1);
foreach ($timers as $timer) {
    dump(Timer::calculateTimerStatusByTimer($timer));
}

Calculate the remaining time of a timer

$timers = Timer::getTimersByOwner('User', 1);
foreach ($timers as $timer) {
    dump(Timer::getRemainingByTimer($timer));
}

Example return:

[
  "finish_at" => \DateTime,
  "seconds" => 59
]

Get a timer instance with updated status

$timers = Timer::getTimersByOwner('User', 1);
$timers[0] = Timer::updateTimerStatusByTimer($timers[0]);

If you like to save this updated timer in the same rush, add a second parameter true:

$timers = Timer::getTimersByOwner('User', 1);
$timers[0] = Timer::updateTimerStatusByTimer($timers[0], true);

Cancel one specific timer

$timers = Timer::getTimersByOwner('User', 1);
Timer::cancelTimerByTimer($timers[0]);

Khazl / timer-laravel