1
0

BeforeUserLoggedInEvent.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  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\Authentication\IApacheBackend;
  27. use OCP\EventDispatcher\Event;
  28. /**
  29. * @since 18.0.0
  30. */
  31. class BeforeUserLoggedInEvent extends Event {
  32. private string $username;
  33. private ?string $password;
  34. private ?IApacheBackend $backend;
  35. /**
  36. * @since 18.0.0
  37. * @since 26.0.0 password can be null
  38. */
  39. public function __construct(string $username, ?string $password, ?IApacheBackend $backend = null) {
  40. parent::__construct();
  41. $this->username = $username;
  42. $this->password = $password;
  43. $this->backend = $backend;
  44. }
  45. /**
  46. * returns the login name, which must not necessarily match to a user ID
  47. *
  48. * @since 18.0.0
  49. */
  50. public function getUsername(): string {
  51. return $this->username;
  52. }
  53. /**
  54. * @since 18.0.0
  55. * @since 26.0.0 value can be null
  56. */
  57. public function getPassword(): ?string {
  58. return $this->password;
  59. }
  60. /**
  61. * return backend if available (or null)
  62. *
  63. * @return IApacheBackend|null
  64. * @since 26.0.0
  65. */
  66. public function getBackend(): ?IApacheBackend {
  67. return $this->backend;
  68. }
  69. }