File: UserNotificationProviderInterface.php

package info (click to toggle)
matomo 5.5.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 73,596 kB
  • sloc: php: 231,041; javascript: 102,286; python: 202; xml: 189; sh: 172; makefile: 20; sql: 10
file content (29 lines) | stat: -rw-r--r-- 763 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\UsersManager\UserNotifications;

interface UserNotificationProviderInterface
{
    /**
     * Provides a list of user notifications to be dispatched,
     * each with their data that can be used, e.g. to populate a notification email
     *
     * @return UserNotificationInterface[]
     */
    public function getUserNotificationsForDispatch(): array;

    /**
     * Sets information that a notification for a set of users has been dispatched
     *
     * @param array $users
     * @return void
     */
    public function setUserNotificationDispatched(array $users): void;
}