Skip to content

jolicode/JoliNotif

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b34dac1 · Jun 1, 2024
May 3, 2024
Apr 24, 2024
May 3, 2024
May 3, 2024
May 3, 2024
May 3, 2024
May 3, 2024
Apr 29, 2024
Apr 29, 2024
Jun 1, 2024
Apr 29, 2024
Mar 1, 2015
May 3, 2024
Apr 9, 2021
Apr 29, 2024
May 31, 2024
May 3, 2024
May 3, 2024
May 3, 2024

Repository files navigation

JoliNotif demo

Total Downloads Latest Stable Version Latest Unstable Version

About JoliNotif

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

Requires PHP >= 8.1 (support for PHP 5 was available in version 1.x, for PHP 7.0 and 7.1 in version < 2.1.0, for PHP 7.2 and 7.3 in version < 2.4.0, for PHP < 8.0 in version 2.6.0).

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)
;

// 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:

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

And finally some meta documentation:

Credits

License

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