dstuecken/notify

Framework agnostic and lightweight notification system with several adapters.

Notify

Framework agnostic and lightweight notification system implementing the PSR LoggerInterface with several handling adapters., _(*1)

Feel free to implement your own handlers!, _(*2)

, _(*3)

Requirements

• PHP 5.4

Installation

Using Composer

To install Notify with Composer, just add the following to your composer.json file:, _(*4)

{
    "require": {
        "dstuecken/notify": "dev-master"
    }
}

or by running the following command:, _(*5)

composer require dstuecken/notify

Usage

Use the Header Handler

<?php
$notificationCenter = new NotificationCenter();
$notificationCenter->addHandler(
    new HeaderHandler('Notify', NotificationCenter::ERROR)
);

$notificationCenter->error('There was an error.');

The Header handler is used to send an HTTP Header to the Browser in the following (changable) format: X-Notify-Notification. This header can then be grabed by a javascript implementation to display a nice and clean javascript error message while continuing the application with a normal response., _(*6)

Use the Logger Handler

You can send your notifications to any LoggerInterface capable logger:, _(*7)

<?php
$logger = new Logger('my-logger');

$notificationCenter = new NotificationCenter();
$notificationCenter->addHandler(
    new LoggerHandler($logger, NotificationCenter::ERROR)
);

$notificationCenter->error('There was an error.');

Use the HipChat Handler

You can also send all your CRITICAL notifications to hipchat, for example:, _(*8)

<?php
$hipchat = new HipChat\HipChat('apiKey123', );

$notificationCenter = new NotificationCenter();
$notificationCenter->addHandler(
    new HipChatHandler($hipchat, 'hipchat-room-id', NotificationCenter::CRITICAL, 'hipChatBotName')
);

$notificationCenter->error('There was an error.');

Push your notifications to several Handlers

You can send your notifications to different handlers in different levels:, _(*9)

<?php
$logger = new Logger('my-logger');

$notificationCenter = new NotificationCenter();
$notificationCenter
    ->addHandler(
        new HeaderHandler(
            'Notify',
            NotificationCenter::INFO
        )
    )
    ->addHandler(
        new LoggerHandler(new Logger(), NotificationCenter::ERROR)
    );

$notificationCenter->error('There was an error.', HeaderHandler::formatAttributes(null, null, true));

Currently implemented Handlers

Header

Sends an HTTP Header, which can be observed by Javascript to represent errors as growl-like notification messages., _(*10)

Logger

Forwards your notifications to a Logger, which implements the LoggerInterface., _(*11)

MacOS

Displays a Mac OS X Notification Center Message., _(*12)

HipChat

Drops notifications on your hipchat rooms., _(*13)

NotifySend

Notify via Ubuntu's notification service., _(*14)

Syslog

Send your notifications to a syslog (using the PHP syslog() function)., _(*15)

Smarty

Attach your notifications to a smarty template variable, _(*16)

Memory

Forward notifications to an array, _(*17)

Tests

Run phpunit tests with, _(*18)

phpunit --bootstrap tests/bootstrap.php tests