README

👁 JoliNotif

JoliNotif

Display desktop notifications from your PHP scripts.

👁 Total Downloads
👁 Latest Stable Version
👁 Latest Unstable Version

JoliNotif is a cross-platform PHP library to display desktop notifications. It works on Linux, Windows (WSL included) or macOS.

👁 JoliNotif demo

Requires PHP >= 8.2 (support for previous PHP versions was available in older releases of this library).

Note

This library can not be used in a web context (FPM or equivalent). Use it in your CLI scripts or in a CRON

Installation

Use Composer to install JoliNotif in your project:

composer require "jolicode/jolinotif"

Usage

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

use Joli\JoliNotif\Notification;
use Joli\JoliNotif\DefaultNotifier;

$notifier = new DefaultNotifier();

// Create your notification
$notification =
 (new Notification())
 ->setTitle('Notification title')
 ->setBody('This is the body of your notification')
 ->setIcon(__DIR__.'/path/to/your/icon.png')
 ->addOption('subtitle', 'This is a subtitle') // Only works on macOS (AppleScriptDriver)
 ->addOption('sound', 'Frog') // Only works on macOS (AppleScriptDriver & TerminalNotifierDriver)
;

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

A shell executable is also provided to use JoliNotif from CLI:

jolinotif --title "Hello" --body "World"

Further documentation

Discover more by reading the docs:

• Basic usage
• Notification
• Drivers
• CRON usage
• CLI 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.

👁 JoliCode is sponsoring this project