phpBB API Documentation
Class

phpbb\notification\type\base

abstract class base implements type_interface

Base notifications class

Properties

static bool|array $notification_option Notification option data (for outputting to the user)

Methods

__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

set_notification_manager(manager $notification_manager)

Set notification manager (required)

set_initial_data(array $data = array())

Set initial data from the database

mixed __get(mixed $name)

Magic method to get data from this notification

null __set(mixed $name, mixed $value)

Magic method to set data on this notification

mixed __toString()

Magic method to get a string of this notification

create_insert_array(array $type_data, array $pre_create_data = array())

Function for preparing the data for insertion in an SQL query

array get_insert_array()

Function for getting the data for insertion in an SQL query

array create_update_array(array $type_data)

Function for preparing the data for update in an SQL query (The service handles insertion)

string|null mark_read(bool $return = false)

Mark this item read

string|null mark_unread(bool $return = false)

Mark this item unread

string get_redirect_url()

{inheritDoc}

array prepare_for_display()

Prepare to output the notification to the template

false get_unsubscribe_url(string|bool $method = false)

URL to unsubscribe to this notification (fall back)

string get_style_class()

Get the CSS style class of the notification (fall back)

string get_avatar()

Get the user's avatar (fall back)

string get_reference()

Get the reference of the notifcation (fall back)

string get_forum()

Get the forum of the notification reference (fall back)

string get_reason()

Get the reason for the notifcation (fall back)

array get_load_special()

Get the special items to load (fall back)

load_special(array $data, array $notifications)

Load the special items (fall back)

bool is_available()

Is available (fall back)

array pre_create_insert_array(array $type_data, array $notify_users)

Pre create insert array function (fall back)

Details

at line 87
public __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

Parameters

driver_interface $db
language $language
user $user
auth $auth
string $phpbb_root_path
string $php_ext
string $user_notifications_table

at line 105
public set_notification_manager(manager $notification_manager)

Set notification manager (required)

Parameters

manager $notification_manager

at line 117
public set_initial_data(array $data = array())

Set initial data from the database

Parameters

array $data Row directly from the database

at line 130
public mixed __get(mixed $name)

Magic method to get data from this notification

Parameters

mixed $name

Return Value

mixed

at line 144
public null __set(mixed $name, mixed $value)

Magic method to set data on this notification

Parameters

mixed $name
mixed $value

Return Value

null

at line 157
public mixed __toString()

Magic method to get a string of this notification

Primarily for testing

Return Value

mixed

at line 188
public create_insert_array(array $type_data, array $pre_create_data = array())

Function for preparing the data for insertion in an SQL query

Parameters

array $type_data The type specific data
array $pre_create_data Data from precreateinsert_array()

at line 206
public array get_insert_array()

Function for getting the data for insertion in an SQL query

Return Value

array Array of data ready to be inserted into the database

at line 222
public array create_update_array(array $type_data)

Function for preparing the data for update in an SQL query (The service handles insertion)

Parameters

array $type_data Data unique to this notification type

Return Value

array Array of data ready to be updated in the database

at line 244
public string|null mark_read(bool $return = false)

Mark this item read

Parameters

bool $return True to return a string containing the SQL code to update this item, False to execute it (Default: False)

Return Value

string|null If $return is False, nothing will be returned, else the sql code to update this item

at line 255
public string|null mark_unread(bool $return = false)

Mark this item unread

Parameters

bool $return True to return a string containing the SQL code to update this item, False to execute it (Default: False)

Return Value

string|null If $return is False, nothing will be returned, else the sql code to update this item

at line 263
public string get_redirect_url()

{inheritDoc}

Return Value

string URL

at line 273
public array prepare_for_display()

Prepare to output the notification to the template

Return Value

array Template variables

at line 313
public false get_unsubscribe_url(string|bool $method = false)

URL to unsubscribe to this notification (fall back)

Parameters

string|bool $method Method name to unsubscribe from (email|jabber|etc), False to unsubscribe from all notifications for this item

Return Value

false

at line 323
public string get_style_class()

Get the CSS style class of the notification (fall back)

Return Value

string

at line 333
public string get_avatar()

Get the user's avatar (fall back)

Return Value

string

at line 343
public string get_reference()

Get the reference of the notifcation (fall back)

Return Value

string

at line 353
public string get_forum()

Get the forum of the notification reference (fall back)

Return Value

string

at line 363
public string get_reason()

Get the reason for the notifcation (fall back)

Return Value

string

at line 373
public array get_load_special()

Get the special items to load (fall back)

Return Value

array Data will be combined sent to load_special() so you can run a single query and get data required for this notification type

at line 384
public load_special(array $data, array $notifications)

Load the special items (fall back)

Parameters

array $data Data from getloadspecial()
array $notifications Array of notifications (key is notification_id, value is the notification objects)

at line 394
public bool is_available()

Is available (fall back)

Return Value

bool True/False whether or not this is available to the user

at line 406
public array pre_create_insert_array(array $type_data, array $notify_users)

Pre create insert array function (fall back)

Parameters

array $type_data The type specific data
array $notify_users Notify users list Formated from findusersfor_notification()

Return Value

array Whatever you want to send to createinsertarray().