bitandblack/cli-notification

Notification sounds and popups from the CLI

0.2.0 2021-07-05 08:45 UTC

This package is auto-updated.

Last update: 2021-10-05 09:18:52 UTC


README

PHP from Packagist Codacy Badge Total Downloads License

CLI Notification

Notification sounds and popups from the CLI.

Installation

This library is made for the use with Composer. Add it to your project by running $ composer require bitandblack/cli-notification.

Usage

Sound

Whenever you want to play a sound, call the Sound::play() method. It needs one parameter—the sound you want to play. This one is an Enum.

The play() method is static, so you don't need to initialize the class.

<?php

use BitAndBlack\CLINotification\Sound;
use BitAndBlack\CLINotification\Enum\SoundEnum;

Sound::play(
    SoundEnum::JOB_DONE()
);

Popup

Whenever you want to show a popup, call the Popup::show() method. It needs You can set the title, the message and an image there.

The show() method is static, so you don't need to initialize the class.

<?php

use BitAndBlack\CLINotification\Popup;

Popup::show(
    'Title', 
    'Message', 
    '/path/to/image.jpg'
);

Help

If you have any questions, feel free to contact us under hello@bitandblack.com.

Further information about Bit&Black can be found under www.bitandblack.com.