gsdu8g9 / JoliNotif

:computer: Send notifications to your desktop directly from your PHP script

JoliNotif

PHP >= 5.4

JoliNotif is a PHP library to send notifications to your desktop directly from your script. It takes care of using the right binary available, without having to worry if you're running on Linux, Windows or MacOS.

For example, if you have a long running PHP task - like executing a large test suite, launching a deployment script - you can use JoliNotif to inform your users that a task just finished.

Installation

Use Composer to install JoliNotif in your project:

composer require "jolicode/jolinotif"

Usage

Use the NotifierFactory to create a Notifier according to which notifiers are available on your system, then use it to send your notification:

include __DIR__.'/vendor/autoload.php';

use Joli\JoliNotif\Notification;
use Joli\JoliNotif\NotifierFactory;

// Create a Notifier
$notifier = NotifierFactory::create();

// Create your notification
$notification =
    (new Notification())
    ->setTitle('Notification title')
    ->setBody('This is the body of your notification')
    ->setIcon(__DIR__.'/path/to/your/icon.png')
;

// Send it
$notifier->send($notification);

Further documentation

Discover more by reading the docs:

• Basic usage
• Notification
• Notifier
• Advanced usage

You can see the current and past versions using one of the following:

• the git tag command
• the releases page on Github
• the file listing the changes between versions

And finally some meta documentation:

• versioning and branching models
• contribution instructions

Credits

• All contributors
• This project was originally inspired by mikaelbr/node-notifier

License

JoliNotif is licensed under the MIT License - see the LICENSE file for details.