Notification
is the main model of JoliNotif. It contains all the options
that should be applied - if possible - by the notifier.
Note: Notifiers are designed to handle the options they support and discard not supported ones gracefully without throwing any exception.
Currently, only three options are supported but new ones could be added later.
Each option can be set via a setter on the Notification
class.
The body is the main message of the notification that you want to display.
Important: This is the only required option. Notifiers will throw an
InvalidNotificationException
if the body is empty or null.
You can also optionally provide a title. Notifiers will certainly display the title above the body, in bold.
An icon can also be displayed inside the notification. You will need to set an absolute path.
$notification->setIcon(__DIR__.'/Resources/icons/success.png');
Note: If you use JoliNotif from a phar and add a notification icon, we will take care to extract this icon in your system temp directory to make it accessible from command line executable.
Not all notifiers support icon but again, you can safely add an icon to your notification since the notifier will discard it if not supported.
Previous pages: