TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent Class Reference

Public Member Functions
	__construct (private readonly AbstractUserAuthentication $user, private readonly ?UserSession $userSession)
	getUser ()
	disableRegularLogoutProcess ()
	enableRegularLogoutProcess ()
	shouldLogout ()
	getUserSession ()

Private Attributes
bool	$shouldLogout = true

Detailed Description

Event fired before a user is going to be actively logged out. An option to interrupt the regular logout flow from TYPO3 Core (so you can do this yourself) is also available.

Definition at line 28 of file BeforeUserLogoutEvent.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::__construct	(	private readonly AbstractUserAuthentication	$user,
		private readonly ?UserSession	$userSession
	)

Definition at line 32 of file BeforeUserLogoutEvent.php.

Member Function Documentation

disableRegularLogoutProcess()

TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::disableRegularLogoutProcess

(

)

Definition at line 42 of file BeforeUserLogoutEvent.php.

References TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent\shouldLogout().

enableRegularLogoutProcess()

TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::enableRegularLogoutProcess

(

)

Definition at line 47 of file BeforeUserLogoutEvent.php.

References TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent\shouldLogout().

getUser()

TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::getUser

(

)

Definition at line 37 of file BeforeUserLogoutEvent.php.

getUserSession()

TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::getUserSession

(

)

Definition at line 57 of file BeforeUserLogoutEvent.php.

shouldLogout()

TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::shouldLogout

(

)

Definition at line 52 of file BeforeUserLogoutEvent.php.

References TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent\$shouldLogout.

Referenced by TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent\disableRegularLogoutProcess(), and TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent\enableRegularLogoutProcess().

Member Data Documentation

$shouldLogout

bool TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent::$shouldLogout = true

private

Definition at line 30 of file BeforeUserLogoutEvent.php.

Referenced by TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent\shouldLogout().