padosoft/laravel-notifier

Laravel Laravel Package for beautifull JS notification.

1.8.1 2024-07-05 09:56 UTC

This package is auto-updated.

Last update: 2024-10-05 10:29:50 UTC


README

Latest Version on Packagist Software License Quality Score Total Downloads SensioLabsInsight

This package provides a wrapper of commands to Padosoft JS notifier, to display beautifull notifications with js plugin.

screenshoot

Table of Contents

##Requires

  • "php" : ">=7.0.0",
  • "illuminate/support": "^5.0|^6.0|^7.0",
  • "illuminate/session": "^5.0|^6.0|^7.0"

Installation

You can install the package via composer:

$ composer require padosoft/laravel-notifier

FOR LARAVEL 5.6+

No additional steps required because the service provider use new L5.5+ autodiscovery feature.

FOR LARAVEL <=5.5

You must install this service provider.

// config/app.php
'provider' => [
    ...
    Padosoft\Laravel\Notification\Notifier\NotifierServiceProvider::class,
    ...
];

USAGE

Call one of these methods in your controllers to insert a notification:

  • Notify::warning($message, $onlyNextRequest = false, $options = []) - add a warning notification
  • Notify::error($message, $onlyNextRequest = false, $options = []) - add an error notification
  • Notify::info($message, $onlyNextRequest = false, $options = []) - add an info notification
  • Notify::success($message, $onlyNextRequest = false, $options = []) - add a success notification
  • Notify::add($theme, $timeout, $type: warning|error|info|success, $layout, $text, $sounds = null, $soundsVolume = null) - add a notification
    • Notify::clear() - clear all current notification

If you need to show the notification only if a particular condition is true, you can use these methods:

  • Notify::ifWarning($condition, $message, $onlyNextRequest = false, $options = []) - add a warning notification if $condition is true
  • Notify::ifError($condition, $message, $onlyNextRequest = false, $options = []) - add an error notification if $condition is true
  • Notify::ifInfo($condition, $message, $onlyNextRequest = false, $options = []) - add an info notification if $condition is true
  • Notify::ifSuccess($condition, $message, $onlyNextRequest = false, $options = []) - add a success notification if $condition is true

Example: instead of use this:

if($condition){
    Notify::success('You have an email!');
}

you can use this:

Notify::IfSuccess($condition, 'You have an email!');
{!! notify() !!}

EXAMPLE:

Notify::info('You have an email!');

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email instead of using the issue tracker.

Credits

About Padosoft

Padosoft (https://www.padosoft.com) is a software house based in Florence, Italy. Specialized in E-commerce and web sites.

License

The MIT License (MIT). Please see License File for more information.