board
class board extends base
In Board notification method class This class handles in board notifications. This method is enabled by default.
Properties
protected manager | $notification_manager | from base | |
protected array | $queue | Queue of messages to be sent |
from base |
protected user_loader | $user_loader | ||
protected driver_interface | $db | ||
protected driver_interface | $cache | ||
protected user | $user | ||
protected config | $config | ||
protected string | $notification_types_table | ||
protected string | $notifications_table |
Methods
Is the method enable by default?
Return the list of the users already notified
Load the user's notifications
Update a notification
{@inheritdoc
Mark notifications read or unread from a parent identifier
Mark notifications read or unread
Delete a notification
Delete all notifications older than a certain time
Purge all notifications of a certain type
Notification Method Board Constructor
Get notification method name
Is this method available for the user? This is checked on the notifications options
Parse the queue and notify the users
Details
in
base at line 36
set_notification_manager(manager $notification_manager)
Set notification manager (required)
at line 95
bool
is_enabled_by_default()
Is the method enable by default?
at line 103
array
get_notified_users(int $notification_type_id, array $options)
Return the list of the users already notified
at line 128
array
load_notifications(array $options = array())
Load the user's notifications
at line 71
add_to_queue(type_interface $notification)
Add a notification to the queue
at line 285
update_notification(type_interface $notification, array $data, array $options)
Update a notification
at line 313
mark_notifications(bool|string $notification_type_id, bool|int|array $item_id, bool|int|array $user_id, bool|int $time = false, bool $mark_read = true)
{@inheritdoc
at line 330
mark_notifications_by_parent(string $notification_type_id, bool|int|array $item_parent_id, bool|int|array $user_id, bool|int $time = false, bool $mark_read = true)
Mark notifications read or unread from a parent identifier
at line 347
mark_notifications_by_id(int $notification_id, bool|int $time = false, bool $mark_read = true)
Mark notifications read or unread
at line 361
delete_notifications(string $notification_type_id, int|array $item_id, mixed $parent_id = false, mixed $user_id = false)
Delete a notification
at line 374
prune_notifications(int $timestamp, bool $only_read = true)
Delete all notifications older than a certain time
at line 387
purge_notifications(string $notification_type_id)
Purge all notifications of a certain type
This should be called when an extension which has notification types is purged so that all those notifications are removed
in
base at line 133
protected
empty_queue()
Empty the queue
at line 56
__construct(user_loader $user_loader, driver_interface $db, driver_interface $cache, user $user, config $config, string $notification_types_table, string $notifications_table)
Notification Method Board Constructor
at line 79
string
get_type()
Get notification method name
at line 87
is_available()
Is this method available for the user? This is checked on the notifications options
at line 265
notify()
Parse the queue and notify the users