PHPFlasher Configuration Options Explained for Beginners

'default' => 'flasher',

This sets the default notification library PHPFlasher will use. Options include:

• flasher: The default built-in adapter
• toastr: For Toastr-style notifications
• noty: For Noty.js notifications
• sweetalert: For SweetAlert notifications

'main_script' => '/vendor/flasher/flasher.min.js',

'styles' => [
    '/vendor/flasher/flasher.min.css',
],

These options control the JavaScript and CSS files that PHPFlasher loads:

• main_script: Path to the main JavaScript file
• styles: Array of CSS files to load

You can change these to use CDN links or custom paths if needed.

// Set global options for all notifications
'options' => [
    'timeout' => 5000,
    'position' => 'top-right',
],

This setting defines default behavior for all notifications:

• timeout: Time in milliseconds before notifications disappear (5000 = 5 seconds)
• position: Where notifications appear (top-right, top-left, bottom-right, bottom-left, etc.)

'inject_assets' => true,

'translate' => true,

These options control important PHPFlasher behaviors:

• inject_assets: When true, PHPFlasher automatically adds the required JavaScript and CSS to your pages
• translate: When true, PHPFlasher will try to translate notification messages using your framework's translation system

'excluded_paths' => [
    'api/*',
    'admin/reports/*',
],

This option lets you specify URL patterns where PHPFlasher should not:

• Inject JavaScript and CSS assets
• Convert framework flash messages to PHPFlasher notifications

This is useful for API routes or admin sections that don't need notifications.

'flash_bag' => [
    'success' => ['success'],
    'error' => ['error', 'danger'],
    'warning' => ['warning', 'alarm'],
    'info' => ['info', 'notice', 'alert'],
],

This option maps your framework's flash message types to PHPFlasher notification types:

• The keys (success, error, etc.) are PHPFlasher notification types
• The values are arrays of framework flash types that map to each PHPFlasher type

This allows PHPFlasher to convert your existing flash messages automatically.

'filter' => [
    'limit' => 5,
    // You can add more filter criteria here
],

This option lets you control which notifications are displayed:

• limit: Maximum number of notifications to show at once

This is helpful to prevent overwhelming users with too many notifications at once.

'presets' => [
    'entity_saved' => [
        'type' => 'success',
        'title' => 'Entity saved',
        'message' => 'Entity saved successfully',
    ],
    'payment_failed' => [
        'type' => 'error',
        'title' => 'Payment failed',
        'message' => 'Your payment could not be processed',
    ],
],

Presets are reusable notification templates that you can use throughout your application:

• Define common notifications once in your configuration
• Use them by name with flash()->preset('entity_saved')

This reduces code duplication and ensures consistent messaging.

// Using the default adapter and settings
flash()->success('Profile updated successfully!');

// Using a specific adapter
toastr()->error('Something went wrong!');

// Using SweetAlert
sweetalert()->info('Please check your email');

These examples use the global configuration options you've set.

// Override global settings for a single notification
flash()->option('timeout', 10000)
       ->option('position', 'bottom-center')
       ->error('This is important!');

// Using presets
flash()->preset('user_created');

// Using presets with custom message
flash()->preset('login_failed', [
    'message' => 'Wrong password. Try again.'
]);

You can override global settings for individual notifications when needed.