PHP Класс phpbb\notification\type\pm

Наследование: extends phpbb\notification\type\base

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$notification_option		Notification option data (for outputting to the user)

Открытые методы

Метод	Описание
create_insert_array ( array $pm, array $pre_create_data = [] ) : array	Function for preparing the data for insertion in an SQL query (The service handles insertion)
find_users_for_notification ( array $pm, array $options = [] ) : array	Find the users who want to receive notifications
get_avatar ( )	Get the user's avatar
get_email_template ( ) : string \| boolean	Get email template
get_email_template_variables ( ) : array	Get email template variables
get_item_id ( array $pm )	Get the id of the
get_item_parent_id ( array $pm )	Get the id of the parent
get_reference ( ) : string	Get the HTML formatted reference of the notification
get_title ( ) : string	Get the HTML formatted title of this notification
get_type ( ) : string	Get notification type name
get_url ( ) : string	Get the url to this item
is_available ( )	Is available
users_to_query ( ) : array	Users needed to query before this notification can be displayed

Описание методов

create_insert_array() публичный Метод

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

public create_insert_array ( array $pm, array $pre_create_data = [] ) : array
$pm	array	Data from submit_post
$pre_create_data	array	Data from pre_create_insert_array()
Результат	array	Array of data ready to be inserted into the database

find_users_for_notification() публичный Метод

Find the users who want to receive notifications

public find_users_for_notification ( array $pm, array $options = [] ) : array
$pm	array	Data from submit_pm
$options	array	Options for finding users for notification
Результат	array

get_avatar() публичный Метод

Get the user's avatar

public get_avatar ( )

get_email_template() публичный Метод

Get email template

public get_email_template ( ) : string \| boolean
Результат	string \| boolean

get_email_template_variables() публичный Метод

Get email template variables

public get_email_template_variables ( ) : array
Результат	array

get_item_id() публичный статический Метод

Get the id of the

public static get_item_id ( array $pm )
$pm	array	The data from the private message

get_item_parent_id() публичный статический Метод

Get the id of the parent

public static get_item_parent_id ( array $pm )
$pm	array	The data from the pm

get_reference() публичный Метод

Get the HTML formatted reference of the notification

public get_reference ( ) : string
Результат	string

get_title() публичный Метод

Get the HTML formatted title of this notification

public get_title ( ) : string
Результат	string

get_type() публичный Метод

Get notification type name

public get_type ( ) : string
Результат	string

get_url() публичный Метод

Get the url to this item

public get_url ( ) : string
Результат	string	URL

is_available() публичный Метод

Is available

public is_available ( )

users_to_query() публичный Метод

Users needed to query before this notification can be displayed

public users_to_query ( ) : array
Результат	array	Array of user_ids

Описание свойств

$notification_option публичное статическое свойство

Notification option data (for outputting to the user)

public static $notification_option