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

Наследование: extends pm
Показать файл Открыть проект

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

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

Защищенные свойства (Protected)

Свойство Тип Описание
$language_key string Language key used to output the text
$permission Permission to check for (in find_users_for_notification)

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

Метод Описание
create_insert_array ( array $post, 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 $post, array $options = [] ) : array Find the users who want to receive notifications (copied from post_in_queue)
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_parent_id ( array $pm ) Get the id of the parent
get_reason ( ) : string Get the reason for the notification
get_reference ( ) : string Get the HTML formatted reference of the notification
get_style_class ( ) : string Get the CSS style class 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 ( ) : boolean Is this type available to the current user (defines whether or not it will be shown in the UCP Edit notification options)
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 $post, array $pre_create_data = [] ) : array
$post 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 (copied from post_in_queue)
public find_users_for_notification ( array $post, array $options = [] ) : array
$post array Data from the post
$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_parent_id() публичный статический Метод

Get the id of the parent
public static get_item_parent_id ( array $pm )
$pm array The data from the pm

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

Get the reason for the notification
public get_reason ( ) : string
Результат string

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

Get the HTML formatted reference of the notification
public get_reference ( ) : string
Результат string

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

Get the CSS style class of the notification
public get_style_class ( ) : 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 this type available to the current user (defines whether or not it will be shown in the UCP Edit notification options)
public is_available ( ) : boolean
Результат boolean True/False whether or not this is available to the user

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

Users needed to query before this notification can be displayed
public users_to_query ( ) : array
Результат array Array of user_ids

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

$language_key защищенное свойство

Language key used to output the text
protected string $language_key
Результат string

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

Notification option data (for outputting to the user)
public static $notification_option

$permission защищенное свойство

Permission to check for (in find_users_for_notification)
protected $permission