Public Member Functions | |
| getGroup () | |
| getRole () | |
| getUser () | |
| setGroup (Group $group) | |
| setRole (Role $role) | |
| setUser (User $user) | |
| reset () | |
Detailed Description
Authentication manager interface.
Sets and retrieves the current user, group or role
Definition at line 15 of file Authentication.php.
Member Function Documentation
◆ getGroup()
| BristolSU\Support\Authentication\Contracts\Authentication::getGroup | ( | ) |
Get a group
- Returns
- Group|null
Implemented in BristolSU\Support\Authentication\ApiAuthentication, BristolSU\Support\Authentication\WebRequestAuthentication, and BristolSU\Support\Testing\Authentication\SessionAuthentication.
◆ getRole()
| BristolSU\Support\Authentication\Contracts\Authentication::getRole | ( | ) |
Get a role
- Returns
- Role|null
Implemented in BristolSU\Support\Authentication\ApiAuthentication, BristolSU\Support\Testing\Authentication\SessionAuthentication, and BristolSU\Support\Authentication\WebRequestAuthentication.
◆ getUser()
| BristolSU\Support\Authentication\Contracts\Authentication::getUser | ( | ) |
Get a user
- Returns
- User|null
Implemented in BristolSU\Support\Authentication\ApiAuthentication, BristolSU\Support\Testing\Authentication\SessionAuthentication, and BristolSU\Support\Authentication\WebRequestAuthentication.
◆ reset()
| BristolSU\Support\Authentication\Contracts\Authentication::reset | ( | ) |
Reset any authentication persistence, to bring the authentication back to an initial clean state.
- Returns
- void
Implemented in BristolSU\Support\Authentication\ApiAuthentication, BristolSU\Support\Testing\Authentication\SessionAuthentication, and BristolSU\Support\Authentication\WebRequestAuthentication.
◆ setGroup()
| BristolSU\Support\Authentication\Contracts\Authentication::setGroup | ( | Group | $group | ) |
Set a group
- Parameters
-
Group $group
- Returns
- void
Implemented in BristolSU\Support\Authentication\ApiAuthentication, BristolSU\Support\Testing\Authentication\SessionAuthentication, and BristolSU\Support\Authentication\WebRequestAuthentication.
◆ setRole()
| BristolSU\Support\Authentication\Contracts\Authentication::setRole | ( | Role | $role | ) |
Set a role
- Parameters
-
Role $role
- Returns
- void
Implemented in BristolSU\Support\Authentication\ApiAuthentication, BristolSU\Support\Testing\Authentication\SessionAuthentication, and BristolSU\Support\Authentication\WebRequestAuthentication.
◆ setUser()
| BristolSU\Support\Authentication\Contracts\Authentication::setUser | ( | User | $user | ) |
Set a user
- Parameters
-
User $user
- Returns
- void
Implemented in BristolSU\Support\Testing\Authentication\SessionAuthentication.
The documentation for this interface was generated from the following file:
- src/Authentication/Contracts/Authentication.php
