library szm-notification

szmnmichalowski/szm-notification

Controller plugin to store notifications in session. Used for notification view helper

SzmNotification

, _(*1)

SzmNotification is a Zend Framework 2/3 controller plugin which stores notification in session container (same as FlashMessanger). It is designed to work with one of the following notifiction helpers: - SzmNoty - jQuery plugin http://ned.im/noty/, _(*2)

Installation

You can install this module via composer, _(*3)

1. Add this project into your composer.json, _(*4)

"require": {
    "szmnmichalowski/szm-notification": "dev-master"
}

2. Update your dependencies, _(*5)

$ php composer.phar update

3. Add module to your application.config.php. It requires Zend\Session, _(*6)

return array(
    'modules' => array(
        'Zend\Session',
        'SzmNotification' // <- Add this line
    )
);

Usage

This plugin has defined 4 types of notifications by default: - info - success - warning - error, _(*7)

But it is possible to add notification under custom type, _(*8)

How to use it

Examples of use:, _(*9)

$this->notification()->add('info', 'Lorem ipsum');
$this->notification()->has('info');
$this->notification()->get('info');

$this->notification()->addInfo('Lorem ipsum');
$this->notification()->hasInfo();
$this->notification()->getInfo();

Available methods:

Global methods: - add($type, $text) - Add notification - has($type) - Check if namespace contains any notification added in previous request - hasCurrent($type) - Check if namespace contains any notification added during this request - get($type) - Return notifications from previous request - getCurrent($type) - Return notifications from current request - getAll() - Return all notifications from previous request - getAllCurrent() - Return all notifications from current request, _(*10)

Following methods are available for each type (including custom type). Just replace * with notification type: - add*($text) - Add notification - has*() - Check if namespace contains any notification added in previous request - hasCurrent*() - Check if namespace contains any notification added during this request - get*() - Return notifications from previous request - getCurrent*() - Return notifications from current request, _(*11)

Examples:, _(*12)

$this-notification()->addCustomType('This is custom type notification');
$this-notification()->addFoo('This is custom type notification');
$this-notification()->addBar('This is custom type notification');

$this-notification()->getCustomType();
$this-notification()->getFoo();
$this-notification()->getCurrentBar();