Евгений Горяев
aka floor12

floor12/yii2-notification: Нотификации в браузере через JS и PHP-api с очередью.

Latest Stable Version Scrutinizer Code Quality Latest Unstable Version Total Downloads License

В любых проектах бывает очень часто необходимо показывать какие-либо нотификации пользователю в ответ на какие-то его действия. Для этих целей я написал эту небольшую библиотеку, у которой нет никаких зависимостей и написана она на чистом javascript.

Нажмите несколько раз на любую из кнопок:

Установка

Добавляем пакет в свой проект:

$ composer require floor12/yii2-notification

или дописываем зависимость руками в composer.json.

"floor12/yii2-notification": "dev-master"

Чтобы необходимые js и css файлы подкючить к проекту, добавляем floor12\notification\NotificationAsset в зависимости вашего AppAsset:

use floor12\notification\NotificationAsset;
use yii\web\AssetBundle;

class AppAsset extends AssetBundle
{
    ...
    public $depends = [
        NotificationAsset::class
    ];
}

Использование c Javascript

Для отображения уведомления в браузере, необходимо вызвать один из методов объекта f12notification и передать туда текст для уведомления. Доступные методы для создания уведомлений:

f12notification.info(text);  // информационное;
f12notification.success(text); //успешное;
f12notification.error(text);  //ошибочное;

Пример использования с использования:

if (userSucces == true)
  f12notification.success('Registration success'.)
else
  f12notification.error('Registration failed.')

Использование c PHP

Так же возможно отобразить уведомлений с помощью php, использовав методы класса floor12\notification\Notification:

use floor12\notification\Notification;

Notification::info('The form is loading...');
Notification::error('Pleas fill all required fields');
Notification::success('This model is saved');

В случае обращения к методам класса floor12\notification\Notification, следить за добавлением floor12\notification\NotificationAsset в ваши ассеты или представления не обязательно, так как он будет добавлен автоматически.

Желающим дополнить или доработать пакет - добро пожаловать в репозиторий на guthub.