[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/phpbb/notification/method/ -> email.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 164 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

email:: (8 methods):
  __construct()
  get_type()
  is_available()
  get_notified_users()
  notify()
  mark_notifications()
  mark_notifications_by_parent()
  clean_data()


Class: email  - X-Ref

Email notification method class
This class handles sending emails for notifications

__construct(\phpbb\user_loader $user_loader, \phpbb\user $user, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, $phpbb_root_path, $php_ext, $notification_emails_table)   X-Ref
Notification Method email Constructor

param: \phpbb\user_loader $user_loader
param: \phpbb\user $user
param: \phpbb\config\config $config
param: \phpbb\db\driver\driver_interface $db
param: string $phpbb_root_path
param: string $php_ext
param: string $notification_emails_table

get_type()   X-Ref
Get notification method name

return: string

is_available(type_interface $notification_type = null)   X-Ref
Is this method available for the user?
This is checked on the notifications options

param: type_interface $notification_type  An optional instance of a notification type. If provided, this
return: bool

get_notified_users($notification_type_id, array $options)   X-Ref
{@inheritdoc}


notify()   X-Ref
Parse the queue and notify the users


mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true)   X-Ref
{@inheritdoc}


mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true)   X-Ref
{@inheritdoc}


clean_data(array $data)   X-Ref
Clean data to contain only what we need for email notifications table

param: array $data Notification data
return: array Cleaned notification data



Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1