iNotificationStore

MMO\client\interfaces · 1 symbol · generated 27 Oct 2026

interface

iNotificationStore

Where the notification centre (Notifications) keeps each recipient's notifications. A JSON file per recipient for now (JsonNotificationStore); a database of its own later, implementing this.

interface MMO\client\interfaces\iNotificationStore

Namespace: MMO\client\interfaces

A notification is `{id, kind, title, body, url, icon, from, createdAt, readAt}`: `kind` what it is about (`dev.ticket`), `url` where it leads, `readAt` null until it is read.

Index

	add($recipient, $notification) abstract
	list($recipient, $limit) abstract
	markRead($recipient, $id, $read) abstract
	unread($recipient) abstract

Methods4

add($recipient, $notification)

abstractiNotificationStore.php:18

abstract function add(string $recipient, array $notification): array

$recipient	string	who it is for (a user's uid)
$notification	array	without `id` nor `createdAt`, which the store gives
returns	array	the notification as kept

list($recipient, $limit)

abstractiNotificationStore.php:25

abstract function list(string $recipient, int $limit = 50): array

$recipient	string
$limit = 50	int	the latest first, at most this many
returns	array

markRead($recipient, $id, $read)

abstractiNotificationStore.php:36

abstract function markRead(string $recipient, ?string $id = null, bool $read = true): int

$recipient	string
$id = null	null \| string	one notification, null for every one
$read = true	bool	false marks it unread again
returns	int	how many changed

unread($recipient)

abstractiNotificationStore.php:28

abstract function unread(string $recipient): int

$recipient	string
returns	int	how many of the recipient's are not read