PHPackages                             phpsoftbox/notifications - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. phpsoftbox/notifications

ActiveLibrary[Mail & Notifications](/categories/mail)

phpsoftbox/notifications
========================

Notification component for the PhpSoftBox framework

036PHP

Since Apr 9Pushed 2mo agoCompare

[ Source](https://github.com/phpsoftbox/notifications)[ Packagist](https://packagist.org/packages/phpsoftbox/notifications)[ RSS](/packages/phpsoftbox-notifications/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Notifications
=============

[](#notifications)

Компонент уведомлений для PhpSoftBox: менеджер, каналы, драйверы (Email/Telegram/Database) и CLI.

Быстрый старт
-------------

[](#быстрый-старт)

```
use PhpSoftBox\Notifications\NotificationManager;
use PhpSoftBox\Notifications\NotificationChannelNames as Channels;

$manager = new NotificationManager([
    $emailChannel,
    $telegramChannel,
    $databaseChannel,
]);

$manager->send($user, new WelcomeNotification());
```

Уведомление определяет каналы и условия отправки:

```
use PhpSoftBox\Notifications\Notification;
use PhpSoftBox\Notifications\NotifiableInterface;
use PhpSoftBox\Notifications\NotificationChannelNames as Channels;

final class WelcomeNotification extends Notification
{
    public function via(NotifiableInterface $notifiable): array
    {
        return [Channels::EMAIL, Channels::DATABASE];
    }

    public function shouldSend(NotifiableInterface $notifiable, string $channel): bool
    {
        return $channel !== Channels::EMAIL || $notifiable->routeNotificationFor(Channels::EMAIL) !== null;
    }
}
```

NotifiableInterface
-------------------

[](#notifiableinterface)

Источник получателя определяет модель:

```
use PhpSoftBox\Notifications\NotifiableInterface;
use PhpSoftBox\Notifications\NotificationChannelNames as Channels;

final class User implements NotifiableInterface
{
    public function routeNotificationFor(string $channel, ?string $driver = null): mixed
    {
        return match ($channel) {
            Channels::EMAIL => $this->email,
            Channels::TELEGRAM => $this->telegramChats[$driver] ?? null,
            Channels::DATABASE => $this->id,
            Channels::PUSHR => $this->pushrChannels[$driver ?? 'default'] ?? null,
            default => null,
        };
    }
}
```

Email
-----

[](#email)

Email-уведомление реализует `EmailNotificationInterface`:

```
use PhpSoftBox\Notifications\Email\EmailNotificationInterface;
use PhpSoftBox\Mailer\Message\EmailMessage;

final class WelcomeNotification extends Notification implements EmailNotificationInterface
{
    public function toEmail(NotifiableInterface $notifiable): EmailMessage
    {
        return EmailMessage::create('Добро пожаловать')
            ->markdown('Спасибо за регистрацию.');
    }
}
```

### SMTP транспорт

[](#smtp-транспорт)

Для SMTP можно использовать отдельный пакет `phpsoftbox/mailer`:

```
use PhpSoftBox\Mailer\Smtp\SmtpClient;
use PhpSoftBox\Mailer\Smtp\SmtpClientConfig;
use PhpSoftBox\Mailer\Transport\SmtpEmailTransport;
use PhpSoftBox\Notifications\Email\EmailChannel;

$smtp = new SmtpClient(new SmtpClientConfig(
    host: 'mailhog',
    port: 1025,
    encryption: 'none',
));

$transport = new SmtpEmailTransport($smtp);
$emailChannel = new EmailChannel($transport, null, null, 'no-reply@example.com');
```

Поддерживаются шаблоны (через `PhpSoftBox\View\ViewRendererInterface`) и Markdown-конвертация (`MarkdownToHtmlConverterInterface`):

```
return EmailMessage::create('Сводка')
    ->template('emails/summary', ['items' => $items], isMarkdown: true);
```

Для HTML-шаблонов можно централизованно оборачивать контент в layout:

```
return EmailMessage::create('Подтверждение email')
    ->template('email/confirm-email', [
        'name' => $userName,
    ])
    ->layout('email/layout.phtml', [
        'title' => 'Подтверждение email',
        'preview' => 'Подтвердите email, чтобы завершить регистрацию.',
        'actionUrl' => $confirmUrl,
        'actionLabel' => 'Подтвердить email',
    ]);
```

Для `template('email/confirm-email')` канал автоматически рендерит (при renderer с поддержкой `TemplateExistsInterface`, например `PhpViewRenderer`):

- HTML: `email/confirm-email.phtml`
- text (если файл существует рядом): `email/confirm-email.text.phtml`

Legacy-вариант с `layout(array $data)` удалён: используйте `layout(string $template, array|object $data = [])`.

Для object-layout используйте DTO, реализующий `PhpSoftBox\View\LayoutTemplateDataInterface`, чтобы канал мог безопасно подставить `content`/`title`:

```
use PhpSoftBox\View\LayoutTemplateDataInterface;

final readonly class EmailLayoutView implements LayoutTemplateDataInterface
{
    public function __construct(
        public ?string $title = null,
        public string $content = '',
        public ?string $preview = null,
    ) {
    }

    public function withLayoutContent(string $content, ?string $defaultTitle = null): object
    {
        return new self(
            title: $this->title ?? $defaultTitle,
            content: $content,
            preview: $this->preview,
        );
    }
}
```

Telegram
--------

[](#telegram)

Telegram-канал использует `TelegramBotRegistry`. Бот выбирается через `TelegramMessage::bot()`.

```
use PhpSoftBox\Notifications\Telegram\TelegramNotificationInterface;
use PhpSoftBox\Notifications\Message\TelegramMessage;

public function toTelegram(NotifiableInterface $notifiable): TelegramMessage
{
    return TelegramMessage::create('Ваш код подтверждения: 1234')
        ->bot('account')
        ->options(['parse_mode' => 'HTML']);
}
```

`routeNotificationFor(Channels::TELEGRAM, $botName)` должен вернуть `chat_id` для выбранного бота.

Database
--------

[](#database)

Database-канал сохраняет адресные уведомления в таблицу `notifications`.

```
use PhpSoftBox\Notifications\Database\DatabaseNotificationInterface;
use PhpSoftBox\Notifications\Message\DatabaseMessage;

public function toDatabase(NotifiableInterface $notifiable): DatabaseMessage
{
    return DatabaseMessage::create('Новое уведомление')
        ->body('Текст уведомления')
        ->data(['level' => 'info']);
}
```

Репозиторий поддерживает чтение:

```
$items = $repository->listForUser($userId, 5);
$unread = $repository->countUnread($userId);
```

Pushr (WebSocket)
-----------------

[](#pushr-websocket)

Pushr-канал публикует событие в WebSocket (Pushr).

```
use PhpSoftBox\Notifications\Pushr\PushrNotificationInterface;
use PhpSoftBox\Notifications\Message\PushrMessage;
use PhpSoftBox\Notifications\Pushr\PushrChannel;
use PhpSoftBox\Notifications\Pushr\PushrPublisherAdapter;
use PhpSoftBox\Broadcaster\Pushr\PushrPublisher;

$pushrChannel = new PushrChannel(
    new PushrPublisherAdapter(new PushrPublisher($appId, $secret, $host)),
);

final class SystemAlertNotification extends Notification implements PushrNotificationInterface
{
    public function toPushr(NotifiableInterface $notifiable): PushrMessage
    {
        return new PushrMessage(
            event: 'notification.created',
            payload: [
                'id' => 10,
                'title' => 'Система',
                'body' => 'Готово.',
            ],
            driver: 'admin',
        );
    }
}
```

`routeNotificationFor(Channels::PUSHR, $driver)` должен вернуть канал (например, `admin.private.user.{id}`).

Аудит отправок (NotificationAuditChannel)
-----------------------------------------

[](#аудит-отправок-notificationauditchannel)

`NotificationAuditChannel` оборачивает любой канал и пишет историю отправок в ваше хранилище (обычно в таблицу БД). Это удобно для админских журналов и разборов инцидентов.

В пакет входят:

- `PhpSoftBox\Notifications\Audit\NotificationAuditChannel`
- `PhpSoftBox\Notifications\Audit\NotificationAuditActor`
- `PhpSoftBox\Notifications\Contracts\NotificationAuditStoreInterface`
- `PhpSoftBox\Notifications\Contracts\NotificationAuditActorResolverInterface`
- `PhpSoftBox\Notifications\Contracts\NotificationAuditToggleInterface`

### Как подключить

[](#как-подключить)

```
use PhpSoftBox\Notifications\Audit\NotificationAuditChannel;
use PhpSoftBox\Notifications\NotificationManager;

$manager = new NotificationManager([
    new NotificationAuditChannel($emailChannel, $auditStore, $actorResolver, $toggle),
    new NotificationAuditChannel($telegramChannel, $auditStore, $actorResolver, $toggle),
    new NotificationAuditChannel($databaseChannel, $auditStore, $actorResolver, $toggle),
]);
```

Где:

- `$auditStore` реализует `NotificationAuditStoreInterface` и сохраняет запись (БД, файл, внешняя система).
- `$actorResolver` реализует `NotificationAuditActorResolverInterface` и возвращает отправителя (`userId`, `name`).
- `$toggle` реализует `NotificationAuditToggleInterface` и включает/выключает аудит (например, через конфиг/настройки).

### Какие данные пишет аудит

[](#какие-данные-пишет-аудит)

Базово:

- `recipientUserId` — адресат в терминах вашей системы (берётся через `routeNotificationFor('database')`, если доступен).
- `recipientTarget` — канал доставки (email, `chat_id`, pushr-channel и т.п.).
- `channel`, `status`, `notificationType`.
- `title`, `body`, `payload`.
- `senderUserId`, `senderName`.

Дополнительно по каналам:

- Email: subject/body, служебные поля (`to`, `cc`, `bcc`, `from`, `reply_to`, `template`).
- Telegram: текст сообщения, имя бота, options.
- Database: title/body/data из `DatabaseMessage`.

Если `toggle->isEnabled()` возвращает `false`, отправка работает как обычно, но история не пишется.

CLI
---

[](#cli)

.

```
make:notification App\\Notifications\\WelcomeNotification
notifications:prune --days=30 --read=1

```

###  Health Score

21

—

LowBetter than 18% of packages

Maintenance56

Moderate activity, may be stable

Popularity9

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/0279d150240c97d210034878b0467462246dc14d29b5618157ff6a8be49a50e3?d=identicon)[inspector-who](/maintainers/inspector-who)

---

Top Contributors

[![inspector-who](https://avatars.githubusercontent.com/u/6973963?v=4)](https://github.com/inspector-who "inspector-who (1 commits)")

### Embed Badge

![Health badge](/badges/phpsoftbox-notifications/health.svg)

```
[![Health](https://phpackages.com/badges/phpsoftbox-notifications/health.svg)](https://phpackages.com/packages/phpsoftbox-notifications)
```

###  Alternatives

[maize-tech/laravel-email-domain-rule

Laravel Email Domain Rule

612.0k](/packages/maize-tech-laravel-email-domain-rule)[sarfraznawaz2005/noty

Laravel package to incorporate noty flash notifications into laravel.

324.5k](/packages/sarfraznawaz2005-noty)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)