nextcloud/lib/public/User/Events/PasswordUpdatedEvent.php

88 lines
2.0 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Morris Jobke <hey@morrisjobke.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\User\Events;
use OCP\EventDispatcher\Event;
use OCP\IUser;
/**
* Emitted when the user password has been updated.
*
* @since 18.0.0
*/
class PasswordUpdatedEvent extends Event {
/** @var IUser */
private $user;
/** @var string */
private $password;
/** @var string|null */
private $recoveryPassword;
/**
* @param IUser $user
* @param string $password
* @param string|null $recoveryPassword
* @since 18.0.0
*/
public function __construct(IUser $user,
string $password,
string $recoveryPassword = null) {
parent::__construct();
$this->user = $user;
$this->password = $password;
$this->recoveryPassword = $recoveryPassword;
}
/**
* @return IUser
* @since 18.0.0
*/
public function getUser(): IUser {
return $this->user;
}
/**
* @return string
* @since 18.0.0
*/
public function getPassword(): string {
return $this->password;
}
/**
* @return string|null
* @since 18.0.0
*/
public function getRecoveryPassword(): ?string {
return $this->recoveryPassword;
}
}