Laravel Convenient System Notifications

, _(*1)

Laravel Notifications , _(*2)

Russian Documentation / Русская документация, _(*3)

Notification system for Laravel 5., _(*4)

Often after saving some data from user you have to redirect to proper page and notificate user that everything done successfully or some errors appeared., _(*5)

Now you can do this more convenient and easy way., _(*6)

Install

To install, execute the following command in the console:, _(*7)

``` BASH $ composer require "garf/laravel-notifications:2.*", _(*8)


When completed, add to your `config/app.php` file in the `providers` section

``` PHP
'providers' => [
    // ...
    Garf\LaravelNotifications\LaravelNotificationsServiceProvider::class,
]

If you want to use Notifications facade, add to same file at the aliases section, _(*9)

``` PHP 'aliases' => [ // ... 'Notifications' => Garf\LaravelNotifications\NotificationsFacade::class, ], _(*10)


To change the templates, please execute the following command in the console:

`php artisan vendor:publish --provider="Garf\LaravelNotifications\LaravelNotificationsServiceProvider" --tag="config"`

Now you will be able to set any view file for notifications render in `config/laravel-notifications.php`.

Optionally you can execute the following command in the console to edit the default template, instead of using your own:

`php artisan vendor:publish --provider="Garf\LaravelNotifications\LaravelNotificationsServiceProvider" --tag="views"`

Note: If you publish the view and edit it, do not change the name of the view in the config file.

## Usage

### Save messages for the next request

``` php
Notifications::add('Your message text', 'type', 'group');

$type param used especially for Twitter Bootstrap render. It displays alerts with respective class., _(*11)

i.e. If you set type to danger, alert with class 'alert alert-danger' will be generated on toBootstrap() format method., _(*12)

$group param groups messages to groups. :) On the next Request you can retrieve them by group., _(*13)

Also more convenient aliases can be used:, _(*14)

``` php Notifications::info('Your message text', 'group'); Notifications::success('Your message text', 'group'); Notifications::warning('Your message text', 'group'); Notifications::danger('Your message text', 'group'); Notifications::error('Your message text', 'group');, _(*15)



### Retrieving messages

#### All messages

``` PHP
Notifications::all()->get();

Messages by group

``` PHP Notifications::byGroup('my-group')->get();, _(*16)


#### Messages by type

``` PHP
Notifications::byType('warning')->get();

Format messages

You also can format messages, _(*17)

JSON

You can retrieve and format all messages as JSON, _(*18)

``` PHP Notifications::all()->toJson();, _(*19)


Or can filter them by group or type

``` PHP
Notifications::byType('success')->toJson();

Notifications::byGroup('login')->toJson();

Render with blade view files

You can also render your notifications with custom view files, _(*20)

``` PHP {{ Notifications::all() }}, _(*21)


And you can filter them by group or type as well:


``` PHP
{{ Notifications::byType('info') }}

{{ Notifications::byGroup('registration') }}

by default method uses Twitter Bootstrap alerts format., _(*22)

Twitter Bootstrap can be required., _(*23)

Other

Count Messages

``` PHP Notifications::all()->count();, _(*24)


#### Check if messages exist

``` PHP
Notifications::all()->has();

Get First Message

``` PHP Notifications::all()->first();, _(*25)


#### Form Request usage
If you want to display errors via Laravel Form Request, you have to override method `formatErrors()` in your Form Request Class.

``` PHP

    public function formatErrors(Validator $validator){
        foreach ($validator->errors()->all() as $error) {
            Notifications::add($error, 'danger');
        }

        return $validator->errors()->getMessages();
    }

Don't forget to import Validator class in head of the file:, _(*26)

use Illuminate\Contracts\Validation\Validator;, _(*27)