| 1: | <?php |
| 2: | /* |
| 3: | * SimpleID |
| 4: | * |
| 5: | * Copyright (C) Kelvin Mo 2021-2025 |
| 6: | * |
| 7: | * This program is free software; you can redistribute it and/or |
| 8: | * modify it under the terms of the GNU General Public |
| 9: | * License as published by the Free Software Foundation; either |
| 10: | * version 2 of the License, or (at your option) any later version. |
| 11: | * |
| 12: | * This program is distributed in the hope that it will be useful, |
| 13: | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14: | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15: | * General Public License for more details. |
| 16: | * |
| 17: | * You should have received a copy of the GNU General Public |
| 18: | * License along with this program; if not, write to the Free |
| 19: | * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 20: | * |
| 21: | */ |
| 22: | |
| 23: | namespace SimpleID\Auth; |
| 24: | |
| 25: | use SimpleID\Models\User; |
| 26: | use SimpleID\Base\AuditEvent; |
| 27: | |
| 28: | /** |
| 29: | * Event to log out a user. |
| 30: | * |
| 31: | * Listeners can use this event to clean up any saved information when a user |
| 32: | * logs out. |
| 33: | * |
| 34: | * The user being logged out can be obtained from the {@link getUser()} |
| 35: | * method. |
| 36: | * |
| 37: | */ |
| 38: | class LogoutEvent extends AuditEvent { |
| 39: | public function __construct(User $user) { |
| 40: | parent::__construct($user); |
| 41: | } |
| 42: | |
| 43: | /** |
| 44: | * Returns the user being logged out. |
| 45: | * |
| 46: | * @return User the user |
| 47: | */ |
| 48: | public function getUser(): User { |
| 49: | /** @var User */ |
| 50: | $user = $this->subject; |
| 51: | return $user; |
| 52: | } |
| 53: | } |
| 54: | |
| 55: | ?> |