group_request
class group_request extends base
Properties
protected manager | $notification_manager | from base | |
protected driver_interface | $db | from base | |
protected language | $language | from base | |
protected user | $user | from base | |
protected auth | $auth | from base | |
protected string | $phpbb_root_path | from base | |
protected string | $php_ext | from base | |
protected string | $user_notifications_table | from base | |
static | $notification_option | {@inheritdoc} | |
protected int | $notification_type_id | The notification_type_id, set upon creation of the class This is the notification_type_id from the notification_types table |
from base |
protected user_loader | $user_loader |
Methods
Notification Type Base Constructor
Get special data (only important for the classes that extend this)
Set special data (only important for the classes that extend this)
Function for preparing the data for insertion in an SQL query
Function for preparing the data for update in an SQL query (The service handles insertion)
URL to unsubscribe to this notification (fall back)
Get the user's avatar (fall back)
Is available (fall back)
Pre create insert array function (fall back)
Find the users who want to receive notifications (helper)
Mark this item read/unread helper
Get a list of users that are authorised to receive notifications
Get notification type name
Get the id of the item
Get the id of the parent
Find the users who want to receive notifications
Get the HTML formatted title of this notification
Get email template
Get email template variables
Get the url to this item
Users needed to query before this notification can be displayed
Details
in
base at line 87
__construct(driver_interface $db, language $language, user $user, auth $auth, string $phpbb_root_path, string $php_ext, string $user_notifications_table)
Notification Type Base Constructor
in
base at line 105
set_notification_manager(manager $notification_manager)
Set notification manager (required)
in
base at line 117
set_initial_data(array $data = array())
Set initial data from the database
in
base at line 130
mixed
__get(mixed $name)
Magic method to get data from this notification
in
base at line 144
null
__set(mixed $name, mixed $value)
Magic method to set data on this notification
in
base at line 157
mixed
__toString()
Magic method to get a string of this notification
Primarily for testing
in
base at line 168
protected mixed
get_data(string $name)
Get special data (only important for the classes that extend this)
in
base at line 180
protected mixed
set_data(string $name, mixed $value)
Set special data (only important for the classes that extend this)
at line 163
create_insert_array($group, array $pre_create_data = array())
Function for preparing the data for insertion in an SQL query
in
base at line 206
array
get_insert_array()
Function for getting the data for insertion in an SQL query
in
base at line 222
array
create_update_array(array $type_data)
Function for preparing the data for update in an SQL query (The service handles insertion)
in
base at line 244
string
mark_read(bool $return = false)
Mark this item read
in
base at line 255
string
mark_unread(bool $return = false)
Mark this item unread
in
base at line 263
string
get_redirect_url()
{inheritDoc}
in
base at line 273
prepare_for_display()
Prepare to output the notification to the template
in
base at line 313
get_unsubscribe_url(string|bool $method = false)
URL to unsubscribe to this notification (fall back)
in
base at line 323
string
get_style_class()
Get the CSS style class of the notification (fall back)
at line 105
string
get_avatar()
Get the user's avatar (fall back)
in
base at line 343
string
get_reference()
Get the reference of the notification (fall back)
in
base at line 353
string
get_forum()
Get the forum of the notification reference (fall back)
in
base at line 363
string
get_reason()
Get the reason for the notification (fall back)
in
base at line 373
array
get_load_special()
Get the special items to load (fall back)
in
base at line 384
load_special(array $data, array $notifications)
Load the special items (fall back)
at line 44
bool
is_available()
Is available (fall back)
in
base at line 406
array
pre_create_insert_array(array $type_data, array $notify_users)
Pre create insert array function (fall back)
in
base at line 423
protected array
check_user_notification_options(array|bool $user_ids = false, array $options = array())
Find the users who want to receive notifications (helper)
in
base at line 522
protected string|null
mark(bool $unread = true, bool $return = false)
Mark this item read/unread helper
in
base at line 554
protected array
get_authorised_recipients(array $users, int $forum_id, array $options, bool $sort = false)
Get a list of users that are authorised to receive notifications
at line 21
string
get_type()
Get notification type name
at line 36
set_user_loader(user_loader $user_loader)
No description
at line 61
static
get_item_id($group)
Get the id of the item
at line 69
static
get_item_parent_id($group)
Get the id of the parent
at line 78
array
find_users_for_notification($group, array $options = array())
Find the users who want to receive notifications
at line 113
string
get_title()
Get the HTML formatted title of this notification
at line 123
string|bool
get_email_template()
Get email template
at line 131
array
get_email_template_variables()
Get email template variables
at line 147
string
get_url()
Get the url to this item
at line 155
array
users_to_query()
Users needed to query before this notification can be displayed