File: UserEmailNotification.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 (64 lines) | stat: -rw-r--r-- 1,684 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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?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;

use Piwik\Container\StaticContainer;

abstract class UserEmailNotification extends UserNotification
{
    /**
     * A list of recipient emails
     *
     * @var array
     */
    private $recipients;

    /**
     * Data in the format of ['email@example.com' => ['item1' => 'value1'], ...] that will be passed to the email class
     *
     * @var array
     */
    private $emailData;

    /**
     * @param array $users A list of users this notification is about
     * @param array $recipients A list of recipients this notification will be sent to
     * @param array $emailData Optional additional data passed to the email notification indexed by a recipient
     */
    public function __construct(
        array $users,
        array $recipients,
        array $emailData = []
    ) {
        parent::__construct($users);

        $this->recipients = array_filter($recipients);
        $this->emailData = $emailData;
    }

    abstract public function getEmailClass(): string;

    public function dispatch(): bool
    {
        foreach ($this->recipients as $recipient) {
            $email = StaticContainer::getContainer()->make(
                $this->getEmailClass(),
                [
                    'notification' => $this,
                    'recipient' => $recipient,
                    'emailData' => $this->emailData[$recipient] ?? [],
                ]
            );
            $email->safeSend();
        }

        return true;
    }
}