#/ PHPFlasher

class BookController
{
    public function saveBook()
    {
        // ...

        flash('Your form has been submitted.');
        
        flash()->addSuccess('Your product has been shipped.');
        
        flash()
            ->success('Your question has been submitted.')
            ->flash();
            
        app('flasher')->addSuccess('Your account has been re-verified.');

        // ... redirect or render the view
    }
    
    /**
     * if you prefer to use dependency injection 
     */
    public function register(FlasherInterface $flasher)
    {
        // ...
        
        $flasher->addSuccess('Your account has been re-verified.');
        
        // ... redirect or render the view
    }
}

#/ usage addSuccess

flash()->addSuccess('Your account has been reinstated.');

#/ usage addError

flash()->addError('There was an issue restoring your account.');

#/ usage addWarning

flash()->addWarning('Your application may not have been received.');

#/ usage addInfo

flash()->addInfo('Your account has been deactivated and a confirmation email has been sent.');

flash()->addFlash(string $type, string $message, string $title = null, array $options = [])

#/ usage addFlash

flash()->addFlash('success', 'The action was completed successfully.');

flash()->options(array $options, bool $merge = true);

#/ usage options

flash()
    ->options([
        'timeout' => 3000, // 3 seconds
        'position' => 'top-center',
    ])
    ->addSuccess('Your password has been reset.');

flash()->option(string $option, mixed $value);

#/ usage option

flash()
    ->option('position', 'top-center')
    ->option('timeout', 3000)
    ->addInfo('Your information has been saved and a confirmation email has been sent.');

flash()->priority(int $priority);

#/ usage priority

flash()
    ->priority(3)
    ->addSuccess('Priority 3 → Your information has been saved.');

flash()
    ->priority(1)
    ->addError('Priority 1 → There was an issue re-verifying your account.');

flash()
    ->priority(4)
    ->addWarning('Priority 4 → Your account may not have been re-activated.');

flash()
    ->priority(2)
    ->addInfo('Priority 2 → Your item has been added to your cart, but may not be reserved until checkout.');

flash()->hops(int $hops);

flash()
    ->hops(2)
    ->addWarning('Your information may not have been saved.');

flash()->translate(string $locale = null);

#/ usage translate

flash()
    ->translate('ar')
    ->addSuccess('Your request was processed successfully.', 'Congratulations!');

#/ usage translate with position

flash()
    ->translate('ar')
    ->option('position', 'top-left')
    ->addSuccess('Your request was processed successfully.', 'Congratulations!');

return [
    'Your request was processed successfully.' => 'تمت العملية بنجاح.',
    'Congratulations!' => 'تهانينا',
];

<?php // config/flasher.php

return [

    /*
    |--------------------------------------------------------------------------
    | Default PHPFlasher library
    |--------------------------------------------------------------------------
    | This option controls the default library that will be used by PHPFlasher
    | to display notifications in your Laravel application. PHPFlasher supports
    | several libraries, including "flasher", "toastr", "noty", "notyf", 
    | "sweetalert" and "pnotify". 
    | 
    | The "flasher" library is used by default. If you want to use a different
    | library, you will need to install it using composer. For example, to use
    | the "toastr" library, run the following command:
    |     composer require php-flasher/flasher-toastr-laravel
    |
    | Here is a list of the supported libraries and the corresponding composer
    | commands to install them:
    |
    | "toastr"     : composer require php-flasher/flasher-toastr-laravel
    | "noty"       : composer require php-flasher/flasher-noty-laravel
    | "notyf"      : composer require php-flasher/flasher-notyf-laravel
    | "sweetalert" : composer require php-flasher/flasher-sweetalert-laravel
    | "pnotify"    : composer require php-flasher/flasher-pnotify-laravel
    */
    'default' => 'flasher',
    
    /*
    |--------------------------------------------------------------------------
    | Main PHPFlasher javascript file 
    |--------------------------------------------------------------------------
    | This option specifies the location of the main javascript file that is
    | required by PHPFlasher to display notifications in your Laravel application.
    |
    | By default, PHPFlasher uses a CDN to serve the latest version of the library.
    | However, you can also choose to download the library locally or install it
    | using npm. 
    |
    | To use the local version of the library, run the following command:
    |     php artisan flasher:install
    |
    | This will copy the necessary assets to your application's public folder. 
    | You can then specify the local path to the javascript file in the 'local'
    | field of this option.
    */
    'root_script' => [
        'cdn' => 'https://cdn.jsdelivr.net/npm/@flasher/flasher@1.2.4/dist/flasher.min.js',
        'local' => '/vendor/flasher/flasher.min.js',
    ],

    /*
    |--------------------------------------------------------------------------
    | Whether to use CDN for PHPFlasher assets or not
    |--------------------------------------------------------------------------
    | This option controls whether PHPFlasher should use CDN links or local assets
    | for its javascript and CSS files. By default, PHPFlasher uses CDN links
    | to serve the latest version of the library. However, you can also choose
    | to use local assets by setting this option to 'false'.
    |
    | If you decide to use local assets, don't forget to publish the necessary
    | files to your application's public folder by running the following command:
    |     php artisan flasher:install
    |
    | This will copy the necessary assets to your application's public folder. 
    */
    'use_cdn' => true,


    /*
    |--------------------------------------------------------------------------
    | Translate PHPFlasher messages
    |--------------------------------------------------------------------------
    | This option controls whether PHPFlasher should pass its messages to the Laravel's
    | translation service for localization. 
    |
    | By default, this option is set to 'true', which means that PHPFlasher will 
    | attempt to translate its messages using the translation service.
    |
    | If you don't want PHPFlasher to use the Laravel's translation service, you can
    | set this option to 'false'. In this case, PHPFlasher will use the messages
    | as-is, without attempting to translate them.
    */
    'auto_translate' => true,

    
    /*
    |--------------------------------------------------------------------------
    | Inject PHPFlasher in Response
    |--------------------------------------------------------------------------
    | This option controls whether PHPFlasher should automatically inject its
    | javascript and CSS files into the HTML response of your Laravel application.
    |
    | By default, this option is set to 'true', which means that PHPFlasher will
    | listen to the response of your application and automatically insert its
    | scripts and stylesheets into the HTML before the closing `</body>` tag.
    |
    | If you don't want PHPFlasher to automatically inject its scripts and stylesheets
    | into the response, you can set this option to 'false'. In this case, you will
    | need to manually include the necessary files in your application's layout.
    */
    'auto_render' => true,

    
    'flash_bag' => [
        /*
        |-----------------------------------------------------------------------
        | Enable flash bag
        |-----------------------------------------------------------------------
        | This option controls whether PHPFlasher should automatically convert
        | Laravel's flash messages to PHPFlasher notifications. This feature is
        | useful when you want to migrate from a legacy system or another
        | library that uses similar conventions for flash messages.
        |
        | When this option is set to 'true', PHPFlasher will check for flash
        | messages in the session and convert them to notifications using the
        | mapping specified in the 'mapping' option. When this option is set
        | to 'false', PHPFlasher will ignore flash messages in the session.
        */
        'enabled' => true,
        
        /*
        |-----------------------------------------------------------------------
        | Flash bag type mapping
        |-----------------------------------------------------------------------
        | This option allows you to map or convert session keys to PHPFlasher
        | notification types. On the left side are the PHPFlasher types.
        | On the right side are the Laravel session keys that you want to
        | convert to PHPFlasher types.
        |
        | For example, if you want to convert Laravel's 'danger' flash
        | messages to PHPFlasher's 'error' notifications, you can add
        | the following entry to the mapping:
        |     'error' => ['danger'],
        */
        'mapping' => [
            'success' => ['success'],
            'error' => ['error', 'danger'],
            'warning' => ['warning', 'alarm'],
            'info' => ['info', 'notice', 'alert'],
        ],
    ],
    
    /*
    |-----------------------------------------------------------------------
    | Global Filter Criteria
    |-----------------------------------------------------------------------
    | This option allows you to filter the notifications that are displayed
    | in your Laravel application. By default, all notifications are displayed,
    | but you can use this option to limit the number of notifications or
    | filter them by type.
    |
    | For example, to limit the number of notifications to 5, you can set
    | the 'limit' field to 5:
    |     'limit' => 5,
    |
    | To filter the notifications by type, you can specify an array of
    | types that you want to display. For example, to only display
    | error notifications, you can set the 'types' field to ['error']:
    |     'types' => ['error'],
    |
    | You can also combine multiple criteria by specifying multiple fields.
    | For example, to display up to 5 error notifications, you can set
    | the 'limit' and 'types' fields like this:
    |     'limit' => 5,
    |     'types' => ['error'],
    */
    'filter_criteria' => [
        'limit' => 5, // Limit the number of notifications to display
    ],

];

<?php // config/flasher.php

return [
    'presets' => [
        'entity_saved' => [
            'type' => 'success',
            'message' => 'Entity saved successfully',
            'title' => 'Entity saved',
        ],
    ],
];

#/ laravel addPreset

class BookController
{
    public function save()
    {
        flash()->addPreset('entity_saved');

class BookController
{
    public function save()
    {
        flash()->addSuccess('Entity saved successfully', 'Entity saved');

<?php // config/flasher.php

return [
    'presets' => [
        'hello_user' => [
            'type' => 'success',
            'message' => 'welcome_back_user',
        ],
    ],
];

<?php // /resources/lang/vendor/flasher/en/messages.php

return [
    'welcome_back_user' => 'Welcome back :username',
];

class BookController
{
    public function save()
    {
        $username = 'John Doe';

        flash()->addPreset('hello_user', ['username' => $username]);

#/ flasher darkMode

// config/flasher.php

return [
    'themes' => [
        'flasher' => [
            'options' => [
                'darkMode' => 'class',
            ],
        ],
    ],
];

return [
    'themes' => [
        'flasher' => [
            'options' => [
                'darkMode' => ['class', '[data-mode="dark"]'],
            ],
        ],
    ],
];

#/ phpflasher rtl

flash()
    ->translate('ar')
    ->addSuccess('Your request was processed successfully.', 'Congratulations!');

<?php // /resources/lang/vendor/flasher/ar/messages.php

return [
        'success' => 'نجاح',
        'error' => 'خطأ',
        'warning' => 'تحذير',
        'info' => 'معلومة',

        'The resource was created' => 'تم إنشاء :resource',
        'The resource was updated' => 'تم تعديل :resource',
        'The resource was saved' => 'تم حفظ :resource',
        'The resource was deleted' => 'تم حذف :resource',

        'resource' => 'الملف',
];

<?php // /resources/lang/vendor/flasher/en/messages.php

return [
    'success' => 'Success',
    'error' => 'Error',
    'warning' => 'Warning',
    'info' => 'Info',

    'The resource was created' => 'The :resource was created',
    'The resource was updated' => 'The :resource was updated',
    'The resource was saved' => 'The :resource was saved',
    'The resource was deleted' => 'The :resource was deleted',

    'resource' => 'resource',
];

<?php // /resources/lang/vendor/flasher/fr/messages.php

return [
        'success' => 'Succès',
        'error' => 'Erreur',
        'warning' => 'Avertissement',
        'info' => 'Information',

        'The resource was created' => 'La ressource :resource a été ajoutée',
        'The resource was updated' => 'La ressource :resource a été mise à jour',
        'The resource was saved' => 'La ressource :resource a été enregistrée',
        'The resource was deleted' => 'La ressource :resource a été supprimée',

        'resource' => '',
];

#/ laravel arabic translations

use Illuminate\Support\Facades\App;

// Set the locale to be used for the translation
App::setLocale('ar');

// Translate the flash message using the PHPFlasher translation files
flash()->addSuccess('The resource was created');

flash()->addError('حدث خطأ أثناء إرسال طلبك.');
flash()->addWarning('يجب إكمال جميع الحقول الإلزامية قبل إرسال النموذج');
flash()->addInfo('سيتم تحديث هذه الصفحة في غضون 10 دقائق.');

#/ laravel french translations

use Illuminate\Support\Facades\App;

// Set the locale to be used for the translation
App::setLocale('fr');

// Translate the flash message using the PHPFlasher translation files
flash()->addSuccess('The resource was created');

flash()->addError('Une erreur s’est produite lors de l’envoi de votre demande.');
flash()->addWarning('Vous devez remplir tous les champs obligatoires avant de soumettre le formulaire.');
flash()->addInfo('Cette page sera mise à jour dans 10 minutes.');

'providers' => [
    ...
    Flasher\Laravel\FlasherServiceProvider::class,
    ...
];

'Flasher' => Flasher\Laravel\Facade\Flasher::class,