NotificatorInterface.php 1.17 KB
Newer Older
Ketan's avatar
Ketan committed
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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

declare(strict_types=1);

namespace Magento\User\Model\Spi;

use Magento\User\Api\Data\UserInterface;

/**
 * Use to send out notifications about user related events.
 */
interface NotificatorInterface
{
    /**
     * Send notification when a user requests password reset.
     *
     * @param UserInterface $user User that requested password reset.
     * @throws NotificationExceptionInterface
     *
     * @return void
     */
    public function sendForgotPassword(UserInterface $user): void;

    /**
     * Send a notification when a new user is created.
     *
     * @param UserInterface $user The new user.
     * @throws NotificationExceptionInterface
     *
     * @return void
     */
    public function sendCreated(UserInterface $user): void;

    /**
     * Send a notification when a user is updated.
     *
     * @param UserInterface $user The user updated.
     * @param string[] $changed List of changed properties.
     * @throws NotificationExceptionInterface
     *
     * @return void
     */
    public function sendUpdated(UserInterface $user, array $changed): void;
}