signalert/laravel-package

A Laravel package for Signalert

Signalert for Laravel

Customisable & Extensible Notifications - Providing Alerts Exactly Where You Need Them, _(*1)

The following Readme details how to install, integrate and use this package within your Laravel installation. For more information on how Signalert works, please visit the Signalert site., _(*2)

Installation

Include this package within your project's composer.json file:, _(*3)

{
    "require": {
        "signalert/laravel-package": "dev-master"
    }
}

Then run composer update signalert/laravel-package, _(*4)

Integration

To integrate this package with your Laravel project, first add the Service Provider to your config/app.php file under the providers array:, _(*5)

'providers' => [
    ...
    Signalert\ServiceProviders\SignalertServiceProvider::class,
];

Now add the Signalert Facade to your aliases, in the same file:, _(*6)

'aliases' => [
    ...
    'Signalert' => Signalert\Facades\Signalert::class,
];

Usage

Since this package works with Laravel Facades, you don't need to instantiate the object, as in the Signalert main package., _(*7)

Signalert makes it simple to store messages:, _(*8)

Signalert::store('Notification Name', 'homepage');

Signalert makes it simple to render messages:, _(*9)

Signalert::render('homepage', 'error');

Signalert even makes it simple to retrieve messages as an array:, _(*10)

Signalert::fetch('homepage', 'error');

Customisation

Please refer to the Signalert site, for more information on how to extend and customise the package., _(*11)