base
abstract class base implements method_interface
Base notifications method class
Properties
protected manager | $notification_manager | ||
protected array | $queue | Queue of messages to be sent |
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
Empty the queue
Details
at line 36
set_notification_manager(manager $notification_manager)
Set notification manager (required)
at line 46
bool
is_enabled_by_default()
Is the method enable by default?
at line 54
array
get_notified_users(int $notification_type_id, array $options)
Return the list of the users already notified
at line 62
array
load_notifications(array $options = array())
Load the user's notifications
at line 76
add_to_queue(type_interface $notification)
Add a notification to the queue
at line 84
update_notification(type_interface $notification, array $data, array $options)
Update a notification
at line 91
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 98
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 105
mark_notifications_by_id(int $notification_id, bool|int $time = false, bool $mark_read = true)
Mark notifications read or unread
at line 112
delete_notifications(string $notification_type_id, int|array $item_id, mixed $parent_id = false, mixed $user_id = false)
Delete a notification
at line 119
prune_notifications(int $timestamp, bool $only_read = true)
Delete all notifications older than a certain time
at line 126
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
at line 133
protected
empty_queue()
Empty the queue