A simple notification management package for Laravel 4 framework .
- Notification containers
- Notification collections
- Notification messages
- Formats for notifications
- Flashable notifications
- Method chaining
- Message aliasing
- Message positioning
Installation
Just place require new package for your laravel installation via composer.json
"edvinaskrucas/notification": "2.*"
Then hit composer update
Registering to use it with laravel
Add following lines to app/config/app.php
ServiceProvider array
'Krucas\Notification\NotificationServiceProvider'
Alias array
'Notification' => 'Krucas\Notification\Facades\Notification'
Now you are able to use it with Laravel4.
Publishing config file
If you want to edit default config file, just publish it to your app folder.
php artisan config:publish edvinaskrucas/notification
Usage
Default usage
Adding message to default container.
Notification::success('Success message');
Notification::error('Error message');
Notification::info('Info message');
Notification::warning('Warning message');
Containers
Containers allows you to set up different containers for different placeholders.
You can pass closure to modify containers, simply use this syntax showed below
Notification::container('myContainer', function($container)
$container->info('Test info message');
$container->error('Error');
);
Also you can access container like this
Notification::container('myContainer')->info('Info message');
Method chaining
Notification::container('myContainer')->info('Info message')->error('Error message');
If you want to use default container just use null as container name. Name will be taken from config file.
Notification::container()->info('Info message');
Instant notifications (shown in same request)
Library supports not only flash messages, if you want to show notifications in same request just use
Notification::successInstant('Instant success message');
Custom single message format
Want a custom format for single message? No problem
Notification::success('Success message', 'Custom format :message');
Add multiple messages
If you want to add multiple notifications you can pass notication message as array
Notification::success(array(
'Message one',
array('Message two with its format', 'My format: :message')
array('message' => 'ok', 'format' => ':message', 'alias' => 'okMsg', 'position' => 5)
));
Also you can still pass second param (format), to format messages, but you can format individual messages as shown above.
Add message as object
You can add messages as objects
Notification::success(
Notification::message('Sample text')
);
When adding message as object you can add additional params to message
Notification::success(
Notification::message('Sample text')->format(':message')
);
Accessing first notification from container
You can access and show just first notification in container
Notification::container('myContainer')->get('success')->first()
Accessing first notification from all types
Notification::container('myContainer')->all()->first()
Displaying notifications
To display all notifications in a default container you need to add just one line to your view file
Notification::showAll()
When using showAll() you may want to group your messages by type, it can be done like this
Notification::group('info', 'success', 'error', 'warning')->showAll()
This will group all your messages in group and output it, also you can use just one, two or three groups.
Manipulating group output on the fly
Notification::addToGrouping('success')->removeFromGrouping('error');
Display notifications by type in default container, you can pass custom format
Notification::showError()
Notification::showInfo()
Notification::showWarning()
Notification::showSuccess(':message')
Displaying notifications in a specific container with custom format.
Notification::container('myContainer')->showInfo(':message')
Message aliasing
You can add message with an alias, then if you want to override that message just add new one with same alias. It works in a same type scope.
Notification::success(Notification::message('ok')->alias('okMsg'));
// We need to override first success message, just alias it with same alias name.
Notification::success(Notification::message('ok2')->alias('okMsg'));
With aliasing you can override message type too
Notification::info(Notification::message('info')->alias('loginMsg'));
// Overrides info message with error message
Notification::error(Notification::message('error')->alias('loginMsg'));
Getting aliased message instance.
Notification::getAliased('loginMsg');
Method getAliased($alias) is available in all scopes (Notification, NotificationBag and Collection), if no message will be found with given alias, null will be returned.
Message positioning
There is ability to add message to certain position. It works in same type scope.
// This will add message at 5th position
Notification::info(Notification::message('info')->position(5));
Notification::info(Notification::message('info2')->position(1);
Retrieving messages at certain position
Notification::getAtPosition(5);
Above example will return message at fifth position in a default container.
Aliasing with a position
You can alias message and add it to a certain position. It works in same type scope.
Notification::info(Notification::message('info')->alias('infoMsg')->position(4));
// If we want to override and set other position
Notification::info(Notification::message('info2')->alias('infoMsg')->position(1));
Clearing messages
You can clear all messages or by type.
Notification::clearError();
Notification::clearWarning();
Notification::clearSuccess();
Notification::clearInfo();
Notification::clearAll();
Add message and display it instantly in a view file
Want to add message in a view file and display it? Its very simple:
Notification::container('myInstant')
->infoInstant('Instant message added in a view and displayed!')
You can also add multiple messages
Notification::container('myInstant')
->infoInstant('Instant message added in a view and displayed!')
->errorInstant('Error...') Download Notification package for Laravel4
Notification package for Laravel 4
No comments:
Post a Comment