PHPXRef 0.7.1 : phpBB-3.1.12-deutsch : Detail view of manager.php

Notifications service class

__construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table) X-Ref

Notification Constructor

param: array $notification_types
param: array $notification_methods
param: ContainerInterface $phpbb_container
param: \phpbb\user_loader $user_loader
param: \phpbb\config\config $config
param: \phpbb\event\dispatcher_interface $phpbb_dispatcher
param: \phpbb\db\driver\driver_interface $db
param: \phpbb\cache\service $cache
param: \phpbb\user $user
param: string $phpbb_root_path
param: string $php_ext
param: string $notification_types_table
param: string $notifications_table
param: string $user_notifications_table
return: \phpbb\notification\manager

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:

mark_notifications_read($notification_type_name, $item_id, $user_id, $time = false) X-Ref

Mark notifications read

param: bool|string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified 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)

mark_notifications_read_by_parent($notification_type_name, $item_parent_id, $user_id, $time = false) X-Ref

Mark notifications read from a parent identifier

param: string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified 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)

mark_notifications_read_by_id($notification_id, $time = false) X-Ref

Mark notifications read

param: int|array $notification_id Notification id or array 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)

add_notifications($notification_type_name, $data, array $options = array() X-Ref

Add a notification

param: string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
param: array $data Data specific for this type that will be inserted
param: array $options Optional options to control what notifications are loaded
return: array Information about what users were notified and how they were notified

add_notifications_for_users($notification_type_name, $data, $notify_users) X-Ref

Add a notification for specific users

param: string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
param: array $data Data specific for this type that will be inserted
param: array $notify_users User list to notify

update_notifications($notification_type_name, $data) X-Ref

Update a notification

param: string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
param: array $data Data specific for this type that will be updated

delete_notifications($notification_type_name, $item_id, $parent_id = false) X-Ref

Delete a notification

param: string|array $notification_type_name Type identifier or array of item types (only acceptable if the $item_id is identical for the specified 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)

get_subscription_types() X-Ref

Get all of the subscription types

return: array Array of item types

get_subscription_methods() X-Ref

Get all of the subscription methods

return: array Array of methods

get_user_notifications($user_id) X-Ref

Get user's notification data

param: int $user_id The user_id of the user to get the notifications for
return: array User's notification

get_global_subscriptions($user_id = false) X-Ref

Get global subscriptions (item_id = 0)

param: bool|int $user_id The user_id to add the subscription for (bool false for current user)
return: array Subscriptions

add_subscription($item_type, $item_id = 0, $method = '', $user_id = false) X-Ref

Add a subscription

param: string $item_type Type identifier of the subscription
param: int $item_id The id of the item
param: string $method The method of the notification e.g. '', 'email', or 'jabber'
param: bool|int $user_id The user_id to add the subscription for (bool false for current user)

delete_subscription($item_type, $item_id = 0, $method = '', $user_id = false) X-Ref

Delete a subscription

param: string $item_type Type identifier of the subscription
param: int $item_id The id of the item
param: string $method The method of the notification e.g. '', 'email', or 'jabber'
param: bool|int $user_id The user_id to add the subscription for (bool false for current user)

disable_notifications($notification_type_name) X-Ref

Disable all notifications of a certain type

This should be called when an extension which has notification types
is disabled so that all those notifications are hidden and do not
cause errors

param: string $notification_type_name Type identifier of the subscription

purge_notifications($notification_type_name) 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_name Type identifier of the subscription

enable_notifications($notification_type_name) X-Ref

Enable all notifications of a certain type

This should be called when an extension which has notification types
that was disabled is re-enabled so that all those notifications that
were hidden are shown again

param: string $notification_type_name Type identifier of the subscription

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

get_item_type_class($notification_type_name, $data = array() X-Ref

Helper to get the notifications item type class and set it up

get_method_class($method_name) X-Ref

Helper to get the notifications method class and set it up

load_object($object_name) X-Ref

Helper to load objects (notification types/methods)

get_notification_type_id($notification_type_name) X-Ref

Get the notification type id from the name

param: string $notification_type_name The name
return: int the notification_type_id

get_notification_type_ids($notification_type_names) X-Ref

Get notification type ids (as an array)

param: string|array $notification_type_names Notification type names
return: array Array of integers

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

PHP Cross Reference of phpBB-3.1.12-deutsch

/phpbb/notification/ -> manager.php (summary)

Defines 1 class