Package Data | |
---|---|
Maintainer Username: | bradcornford |
Maintainer Contact: | me@bradleycornford.co.uk (Bradley Cornford) |
Package Create Date: | 2014-05-11 |
Package Last Update: | 2016-07-26 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-11-15 15:10:25 |
Package Statistics | |
---|---|
Total Downloads: | 70 |
Monthly Downloads: | 0 |
Daily Downloads: | 0 |
Total Stars: | 16 |
Total Watchers: | 2 |
Total Forks: | 1 |
Total Open Issues: | 0 |
Think of Alerter as an easy way to manage user alerting, providing a variety of alert options to speed up user alerting. These include:
Alert::create
Alert::error
Alert::info
Alert::warning
Alert::success
Alert::none
It comes with a variety of template pre-built for some of the most popular CSS Frameworks. These include:
Bootstrap
Foundation
Pure
It is also full customisable, allowing new templates to be created, along with new alert types too.
Begin by installing this package through Composer. Edit your project's composer.json
file to require cornford/alerter
.
"require-dev": {
"cornford/alerter": "2.*"
}
Next, update Composer from the Terminal:
composer update --dev
Once this operation completes, the final step is to add the service provider. Open app/config/app.php
, and add a new item to the providers array.
'Cornford\Alerter\AlerterServiceProvider'
That's it! You're all set to go.
It's really as simple as using the Alerter class in any Controller / Model / File you see fit with:
use Cornford\Alerter\Alert;
This will give you access to
The create
method allows you to create a new Alert with any of the pre-built types, or specify your own.
Alert::create(Alert::TYPE_ERROR, 'This is an error message!')->display();
Alert::create('Custom', 'This is a custom message!')->display();
Both the type
and content
options are required.
The error
method allows you to create a new Alert Error without specifying type.
Alert::error('This is an error message!')->display();
The content
option is required.
The info
method allows you to create a new Alert Info without specifying type.
Alert::info('This is an info message!')->display();
The content
option is required.
The warning
method allows you to create a new Alert Warning without specifying type.
Alert::warning('This is a warning message!')->display();
The content
option is required.
The success
method allows you to create a new Alert Success without specifying type.
Alert::Success('This is a success message!')->display();
The content
option is required.
The none
method allows you to create a new Alert None without specifying type.
Alert::None('This is a none message!')->display();
The content
option is required.
Alerter is open-sourced software licensed under the MIT license