PHP code example of pxlrbt / laravel-notification-preview

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

pxlrbt / laravel-notification-preview example snippets

// config/notification-preview.php
return [
    'enabled' => env('NOTIFICATION_PREVIEW_ENABLED', true),

    // The kinds of classes to look for. Turn either off to skip it entirely.
    'notifications' => env('NOTIFICATION_PREVIEW_NOTIFICATIONS', true),
    'mailables' => env('NOTIFICATION_PREVIEW_MAILABLES', true),

    'url_prefix' => env('NOTIFICATION_PREVIEW_URL_PREFIX', 'dev/notifications'),
    'middleware' => ['web'],

    // Directories, scanned recursively.
    'paths' => [
        app_path('Notifications'),
        app_path('Mail'),
    ],

    // Class names and namespaces to hide.
    'exclude' => [],

    // null falls back to the directories inside lang_path()
    'locales' => null,

    'test_email' => env('NOTIFICATION_PREVIEW_TEST_EMAIL'),
];

'channels' => ['mail', 'database', 'smsapi'],

use pxlrbt\LaravelNotificationPreview\Facades\NotificationPreview;

// Local machines only.
NotificationPreview::auth(fn () => app()->isLocal());

// Or specific people, wherever they are.
NotificationPreview::auth(fn (?Request $request) => $request?->user()?->isAdmin());

'exclude' => [
    App\Notifications\Internal\DebugPing::class,   // one class
    'App\Notifications\Internal',                  // the whole namespace
],

use pxlrbt\LaravelNotificationPreview\Facades\NotificationPreview;

NotificationPreview::resolve(Order::class, fn () => Order::factory()->make(['id' => 1]));

NotificationPreview::resolve(
    StateNotification::class.'::$model',
    fn () => Order::factory()->make(),
);

NotificationPreview::notifiable(fn () => User::factory()->make(['id' => 1]));

use pxlrbt\LaravelNotificationPreview\Facades\NotificationPreview;
use pxlrbt\LaravelNotificationPreview\Variant;

NotificationPreview::for(OrderCancelled::class)
    ->label('Cancellation')
    ->group('Orders')
    ->variants([
        Variant::make('by-customer', fn () => (new OrderCancelled($order))->setReason('customer')),
        Variant::make('by-us', fn () => (new OrderCancelled($order))->setReason('internal')),
    ]);

NotificationPreview::for(OrderCancelled::class)
    ->label(fn () => __('notifications.order_cancelled'))
    ->group(fn () => __('notifications.groups.orders'));

Variant::make('by-customer', $factory)->label(fn () => __('variants.by_customer'));

NotificationPreview::for(OrderShipped::class)->variants([
    Variant::make('to-the-buyer', fn () => new OrderShipped($order))
        ->notifiable(fn () => User::factory()->make(['id' => 2])),
]);

use pxlrbt\LaravelNotificationPreview\Preview;
use pxlrbt\LaravelNotificationPreview\Variant;

class OrderShipped extends Notification
{
    public static function preview(Preview $preview): void
    {
        $preview
            ->label('Shipping confirmation')
            ->group('Orders')
            ->variants([
                Variant::make('express', fn () => new self(Order::factory()->express()->make())),
                Variant::make('standard', fn () => new self(Order::factory()->make())),
            ]);
    }
}

NotificationPreview::register(SomePackage\Notifications\Welcome::class);

// Same matching rules as the `exclude` config key.
NotificationPreview::exclude(InternalDebugNotification::class);
NotificationPreview::exclude('App\Notifications\Internal');