README

This package provides a simple and easy way to check if an Actor in your application is active or was active recently. In most cases Actor will be your app user, but in some cases it can be some logic like a bot, variable Cronjob, Queue or another external proces you want to monitor.

The package doesn't require any database migrations because it's built on the Laravel Cache Driver.

Requirements

Laravel Actor is Online requires PHP 8+ and Laravel 6+.

Installation

You can install the package via composer:

composer require djl997/laravel-actor-is-active

Prepare your actor model:

namespace App\Models;

use Djl997\LaravelActorIsActive\Traits\IsOnlineTrait;

class Actor {

    use IsOnlineTrait;

    // ..

}

Set online status
- Route Middleware (recommended for Auth)
- Manually

Route Middleware (recommended for Authenticables)

Activate the middleware to automatically update the online status of Users in your application, add the following to your app/Http/Kernel.php file:

protected $middlewareGroups = [
    'web' => [
        // ..
        \Djl997\LaravelActorIsActive\Http\Middleware\IsOnline::class,
    ]
];

Manually

If you want to update the status manually or if middleware is not applicable in your case:

$model = Model::find(1);

$model->touchOnline();

Advanced Usage

$user = User::find(1);

$user->isOnline(); // returns true if user is online
$user->wasOnlineRecently(); // returns true if user was inline x minutes ago (by default 5-30 minutes, customizable via config)
$user->lastOnlineAt(); // returns Carbon object of last online timestamp
$user->getCacheActorOnlineKey(); // get the online cache key

Contributing

Contributions are welcome.

License

The MIT License (MIT). Please see License File for more information.

djl997 / laravel-actor-is-active

Maintainers

Details