Notifications в Database

Для работы драйвера database, необходима таблица в выбраной базе данных. Для создания таблицы выполните команды:

php imhotep notification:table
php imhotep migrate
BASH

Формирование уведомлений

Для сохранения уведомлений в базе данных необходимо определить метод toDatabase(mixed $recipient) или toArray(mixed $recipient) в классе вашего уведомления. Этот метод должен возвращать обычный PHP-массив. Возвращаемый массив будет преобразован в формат JSON и сохранен в столбце data таблицы notifications.

Также вы можете определить два дополнительных метода: databaseType и databaseReadAt.

namespace App\Notifications;

use Imhotep\Notifications\Notification;

class MyNotification extends Notification
{
    // ..
    
    public function toArray(mixed $recipient): array
    {
        return [
            'order_id' => $this->order->id,
            'total' => $this->order->total,
        ];
    }
    
    public function databaseType(mixed $recipient): string
    {
        // Возвращает значение для столбца «type» в базе данных
        // Если функция не определена, значением будет имя класса уведомления
    
        return 'order-created';
    }
    
    public function databaseReadAt(): mixed
    {
        // Возвращает начальное значение для столбца «read_at» в базе данных
        // Допустимые значения: null, timestamp, DateTime или string
        return null;
    }
}
PHP

Доступ к уведомлениям

Для доступа к уведомлениям, сохранённым в базе данных, подключите трейт Imhotep\Notifications\Notifiable к классу, представляющему уведомляемый объект (например, модель User). Этот трейт добавляет методы notifications, readNotifications и unreadNotifications которые возвращают Database Repository:

// Возвращает все уведомления пользователя,
// отсортированные по столбу `created_at` в порядке убывания
foreach ($user->notifications()->get() as $notification) {
    echo $notification->type;
}

// Возвращает только прочитанные уведомления,
// отсортированные по столбу `created_at` в порядке убывания
foreach ($user->unreadNotifications()->get() as $notification) {
    echo $notification->type;
}

// Возвращает только непрочитанные уведомления,
// отсортированные по столбу `created_at` в порядке убывания
foreach ($user->readNotifications()->get() as $notification) {
    echo $notification->type;
}
PHP

Отметить как прочитаное

Чтобы отметить уведомление как прочитанное, воспользуйтесь методом markAsRead(). В метод можно передать ID конкретного уведомления или массив идентификаторов. Метод установит значение поля read_at в таблице notifications на текущую временную метку.

// Пометить конкретное уведомление как прочитанное
$user->unreadNotifications()->markAsRead($notificationId);

// Пометить несколько уведомлений как прочитанные
$user->unreadNotifications()->markAsRead([$id1, $id2, $id3]);

// Пометить все непрочитанные уведомления как прочитанные
$user->unreadNotifications()->markAsRead();
PHP

Удаление уведомлений

Для полного удаления уведомления из базы данных воспользуйтесь методом delete.

foreach ($user->unreadNotifications()->get() as $notification) {
    $user->unreadNotifications()->delete($notification);
}
PHP