[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/phpbb/notification/method/ -> method_interface.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: 149 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

method_interface:: (14 methods):
  get_type()
  is_enabled_by_default()
  is_available()
  get_notified_users()
  load_notifications()
  add_to_queue()
  notify()
  update_notification()
  mark_notifications()
  mark_notifications_by_parent()
  mark_notifications_by_id()
  delete_notifications()
  prune_notifications()
  purge_notifications()


Interface: method_interface  - X-Ref

Base notifications method interface

get_type()   X-Ref
Get notification method name

return: string

is_enabled_by_default()   X-Ref
Is the method enable by default?

return: bool

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


get_notified_users($notification_type_id, array $options)   X-Ref
Return the list of the users already notified

param: int $notification_type_id ID of the notification type
param: array $options
return: array User

load_notifications(array $options = array()   X-Ref
Load the user's notifications

param: array $options Optional options to control what notifications are loaded
return: array Array of information based on the request with keys:

add_to_queue(\phpbb\notification\type\type_interface $notification)   X-Ref
Add a notification to the queue

param: \phpbb\notification\type\type_interface $notification

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


update_notification($notification, array $data, array $options)   X-Ref
Update a notification

param: \phpbb\notification\type\type_interface $notification Notification to update
param: array $data Data specific for this type that will be updated
param: array $options

mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true)   X-Ref
Mark notifications read or unread

param: bool|string $notification_type_id Type identifier of item types. False to mark read for all item types
param: bool|int|array $item_id Item id or array of item ids. False to mark read for all item ids
param: bool|int|array $user_id User id or array of user ids. False to mark read for all user ids
param: bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
param: bool $mark_read Define if the notification as to be set to True or False. (Default: True)

mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true)   X-Ref
Mark notifications read or unread from a parent identifier

param: string $notification_type_id Type identifier of item types
param: bool|int|array $item_parent_id Item parent id or array of item parent ids. False to mark read for all item parent ids
param: bool|int|array $user_id User id or array of user ids. False to mark read for all user ids
param: bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
param: bool $mark_read Define if the notification as to be set to True or False. (Default: True)

mark_notifications_by_id($notification_id, $time = false, $mark_read = true)   X-Ref
Mark notifications read or unread

param: int $notification_id Notification id of notification ids.
param: bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
param: bool $mark_read Define if the notification as to be set to True or False. (Default: True)

delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false)   X-Ref
Delete a notification

param: string $notification_type_id Type identifier of item types
param: int|array $item_id Identifier within the type (or array of ids)
param: mixed $parent_id Parent identifier within the type (or array of ids), used in combination with item_id if specified (Default: false; not checked)
param: mixed $user_id User id (Default: false; not checked)

prune_notifications($timestamp, $only_read = true)   X-Ref
Delete all notifications older than a certain time

param: int $timestamp Unix timestamp to delete all notifications that were created before
param: bool $only_read True (default) to only prune read notifications

purge_notifications($notification_type_id)   X-Ref
Purge all notifications of a certain type

This should be called when an extension which has notification types
is purged so that all those notifications are removed

param: string $notification_type_id Type identifier of the subscription



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