Inheritance diagram for BristolSU\Support\User\Contracts\UserAuthentication:
Public Member Functions | |
| getUser () | |
| setUser (User $user) | |
| logout () | |
Detailed Description
Contract to set or resolve a logged in user
Definition at line 10 of file UserAuthentication.php.
Member Function Documentation
◆ getUser()
| BristolSU\Support\User\Contracts\UserAuthentication::getUser | ( | ) |
Get the currently set user
- Returns
- User|null Returns the user, or null if no user found
Implemented in BristolSU\Support\User\UserWebAuthentication, and BristolSU\Support\User\UserApiAuthentication.
◆ logout()
| BristolSU\Support\User\Contracts\UserAuthentication::logout | ( | ) |
Log out of the current user
- Returns
- void
Implemented in BristolSU\Support\User\UserApiAuthentication, and BristolSU\Support\User\UserWebAuthentication.
◆ setUser()
| BristolSU\Support\User\Contracts\UserAuthentication::setUser | ( | User | $user | ) |
Set the currently logged in user
- Returns
- void
Implemented in BristolSU\Support\User\UserApiAuthentication, and BristolSU\Support\User\UserWebAuthentication.
The documentation for this interface was generated from the following file:
- src/User/Contracts/UserAuthentication.php
