UserLoggedOutEvent.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\User\Events;
  26. use OCP\EventDispatcher\Event;
  27. use OCP\IUser;
  28. /**
  29. * Emitted when a user has been logged out successfully.
  30. *
  31. * @since 18.0.0
  32. */
  33. class UserLoggedOutEvent extends Event {
  34. /** @var IUser|null */
  35. private $user;
  36. /**
  37. * @since 18.0.0
  38. */
  39. public function __construct(?IUser $user = null) {
  40. parent::__construct();
  41. $this->user = $user;
  42. }
  43. /**
  44. * @since 18.0.0
  45. */
  46. public function getUser(): ?IUser {
  47. return $this->user;
  48. }
  49. }