mirror of
https://github.com/archtechx/tenancy.git
synced 2026-05-07 11:54:04 +00:00
Improve stopImpersonating docblock
This commit is contained in:
parent
3c9d532582
commit
a5f5182db2
1 changed files with 7 additions and 1 deletions
|
|
@ -81,7 +81,13 @@ class UserImpersonation implements Feature
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logout from the current domain and forget impersonation session.
|
* Stop user impersonation by forgetting the impersonation session.
|
||||||
|
*
|
||||||
|
* When $logout is true, the user will also be logged out
|
||||||
|
* from the impersonation guard stored in the session.
|
||||||
|
*
|
||||||
|
* Throws an exception if impersonation is not active
|
||||||
|
* (= the impersonation guard is not in the session).
|
||||||
*/
|
*/
|
||||||
public static function stopImpersonating(bool $logout = true): void
|
public static function stopImpersonating(bool $logout = true): void
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue