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

Наследование: extends phpbb\notification\type\base
Показать файл Открыть проект Примеры использования класса

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

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

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

Свойство Тип Описание
$inherit_read_status boolean Inherit notification read status from post.
$language_key string Language key used to output the text

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

Метод Описание
add_responders ( mixed $post ) Add responders to the 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
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 $post ) Get the id of the item
get_item_parent_id ( array $post ) Get the id of the parent
get_redirect_url ( ) {inheritDoc}
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
pre_create_insert_array ( array $post, array $notify_users ) : array Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().
trim_user_ary ( array $users ) : array Trim the user array passed down to 3 users if the array contains more than 4 users.
users_to_query ( ) : array Users needed to query before this notification can be displayed

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

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

Add responders to the notification
public add_responders ( mixed $post )
$post mixed

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
public find_users_for_notification ( array $post, array $options = [] ) : array
$post array Data from submit_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_id() публичный статический Метод

Get the id of the item
public static get_item_id ( array $post )
$post array The data from the post

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

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

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

{inheritDoc}
public get_redirect_url ( )

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 ( )

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

Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().
public pre_create_insert_array ( array $post, array $notify_users ) : array
$post array Post data from submit_post
$notify_users array Notify users list Formated from find_users_for_notification()
Результат array Whatever you want to send to create_insert_array().

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

Trim the user array passed down to 3 users if the array contains more than 4 users.
public trim_user_ary ( array $users ) : array
$users array Array of users
Результат array Trimmed array of user_ids

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

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

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

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

Inherit notification read status from post.
protected bool $inherit_read_status
Результат boolean

$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