TYPO3\CMS\Beuser\Controller\BackendUserController Class Reference

Inheritance diagram for TYPO3\CMS\Beuser\Controller\BackendUserController:

Public Member Functions
	__construct (ModuleDataStorageService $moduleDataStorageService, BackendUserRepository $backendUserRepository, BackendUserGroupRepository $backendUserGroupRepository, BackendUserSessionRepository $backendUserSessionRepository, UserInformationService $userInformationService)
	processRequest (RequestInterface $request, ResponseInterface $response)
	indexAction (Demand $demand=null)
	onlineAction ()
	showAction (int $uid=0)
	compareAction ()
	initiatePasswordResetAction (int $user)
	addToCompareListAction ($uid)
	removeFromCompareListAction ($uid, int $redirectToCompare=0)
	removeAllFromCompareListAction ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
	injectObjectManager (ObjectManagerInterface $objectManager)
	injectSignalSlotDispatcher (Dispatcher $signalSlotDispatcher)
	injectValidatorResolver (ValidatorResolver $validatorResolver)
	injectViewResolver (ViewResolverInterface $viewResolver)
	injectReflectionService (ReflectionService $reflectionService)
	injectCacheService (CacheService $cacheService)
	injectHashService (HashService $hashService)
	injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
	injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
	initializeControllerArgumentsBaseValidators ()
ControllerContext	getControllerContext ()
	addFlashMessage ($messageBody, $messageTitle='', $severity=AbstractMessage::OK, $storeInSession=true)
bool	canProcessRequest (RequestInterface $request)
	forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
	throwStatus ($statusCode, $statusMessage=null, $content=null)

Public Attributes
const	RECENT_USERS_LIMIT = 3

Protected Member Functions
	initializeView (ViewInterface $view)
	terminateBackendUserSessionAction (BackendUser $backendUser, $sessionId)
	switchUser ($switchUser)
int[]	generateListOfMostRecentSwitchedUsers (int $targetUserUid)
BackendUserAuthentication	getBackendUserAuthentication ()
SessionBackendInterface	getSessionBackend ()
array	getOnlineBackendUsers ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeAction ()
	initializeActionMethodArguments ()
	initializeActionMethodValidators ()
	renderAssetsForRequest ($request)
string	resolveActionMethodName ()
	callActionMethod ()
	emitBeforeCallActionMethodSignal (array $preparedArguments)
ViewInterface	resolveView ()
	setViewConfiguration (ViewInterface $view)
array	getViewProperty ($extbaseFrameworkConfiguration, $setting)
string	errorAction ()
	clearCacheOnError ()
	addErrorFlashMessage ()
string	getErrorFlashMessage ()
	forwardToReferringRequest ()
string	getFlattenedValidationErrorMessage ()
TYPO3 CMS Extbase Mvc Controller ControllerContext	buildControllerContext ()
	redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
	redirectToUri ($uri, $delay=0, $statusCode=303)
string	addBaseUriIfNecessary ($uri)
	mapRequestArgumentsToControllerArguments ()

Protected Attributes
TYPO3 CMS Beuser Domain Model ModuleData	$moduleData
ModuleDataStorageService	$moduleDataStorageService
BackendUserRepository	$backendUserRepository
BackendUserGroupRepository	$backendUserGroupRepository
BackendUserSessionRepository	$backendUserSessionRepository
UserInformationService	$userInformationService
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService	$reflectionService
TYPO3 CMS Extbase Service CacheService	$cacheService
HashService	$hashService
ViewInterface	$view
string	$defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
string	$actionMethodName = 'indexAction'
string	$errorMethodName = 'errorAction'
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService	$mvcPropertyMappingConfigurationService
EventDispatcherInterface	$eventDispatcher
TYPO3 CMS Extbase Mvc Request	$request
TYPO3 CMS Extbase Mvc Response	$response
TYPO3 CMS Extbase SignalSlot Dispatcher	$signalSlotDispatcher
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager
TYPO3 CMS Extbase Mvc Web Routing UriBuilder	$uriBuilder
array	$settings
TYPO3 CMS Extbase Validation ValidatorResolver	$validatorResolver
TYPO3 CMS Extbase Mvc Controller Arguments	$arguments
array	$supportedRequestTypes = array( Request::class )
TYPO3 CMS Extbase Mvc Controller ControllerContext	$controllerContext
ConfigurationManagerInterface	$configurationManager

Detailed Description

Backend module user administration controller

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Definition at line 47 of file BackendUserController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Beuser\Controller\BackendUserController::__construct	(	ModuleDataStorageService	$moduleDataStorageService,
		BackendUserRepository	$backendUserRepository,
		BackendUserGroupRepository	$backendUserGroupRepository,
		BackendUserSessionRepository	$backendUserSessionRepository,
		UserInformationService	$userInformationService
	)

Definition at line 78 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\$backendUserGroupRepository, TYPO3\CMS\Beuser\Controller\BackendUserController\$backendUserRepository, TYPO3\CMS\Beuser\Controller\BackendUserController\$backendUserSessionRepository, TYPO3\CMS\Beuser\Controller\BackendUserController\$moduleDataStorageService, and TYPO3\CMS\Beuser\Controller\BackendUserController\$userInformationService.

Member Function Documentation

addToCompareListAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::addToCompareListAction

(

$uid

)

Attaches one backend user to the compare list

Parameters

int

$uid

Definition at line 255 of file BackendUserController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\forward().

compareAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::compareAction

(

)

Compare backend users from demand

Definition at line 197 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\getOnlineBackendUsers(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\redirect().

generateListOfMostRecentSwitchedUsers()

int [] TYPO3\CMS\Beuser\Controller\BackendUserController::generateListOfMostRecentSwitchedUsers ( int  $targetUserUid )

protected

Generates a list of users to whom where switched in the past. This is limited by RECENT_USERS_LIMIT.

Parameters

int

$targetUserUid

Returns

‪int[]

Definition at line 364 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\getBackendUserAuthentication().

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\switchUser().

getBackendUserAuthentication()

BackendUserAuthentication TYPO3\CMS\Beuser\Controller\BackendUserController::getBackendUserAuthentication ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 388 of file BackendUserController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\generateListOfMostRecentSwitchedUsers(), TYPO3\CMS\Beuser\Controller\BackendUserController\getSessionBackend(), TYPO3\CMS\Beuser\Controller\BackendUserController\indexAction(), TYPO3\CMS\Beuser\Controller\BackendUserController\onlineAction(), and TYPO3\CMS\Beuser\Controller\BackendUserController\switchUser().

getOnlineBackendUsers()

array TYPO3\CMS\Beuser\Controller\BackendUserController::getOnlineBackendUsers ( )

protected

Create an array with the uids of online users as the keys [ 1 => true, 5 => true ]

Returns

‪array

Definition at line 410 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\compareAction(), and TYPO3\CMS\Beuser\Controller\BackendUserController\indexAction().

getSessionBackend()

SessionBackendInterface TYPO3\CMS\Beuser\Controller\BackendUserController::getSessionBackend ( )

protected

Returns

‪SessionBackendInterface

Definition at line 396 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\getBackendUserAuthentication(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getLoginType().

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\onlineAction(), TYPO3\CMS\Beuser\Controller\BackendUserController\switchUser(), and TYPO3\CMS\Beuser\Controller\BackendUserController\terminateBackendUserSessionAction().

indexAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::indexAction

(

Demand

$demand = null

)

Displays all BackendUsers

• ‪Switch session to different user

Parameters

\TYPO3\CMS\Beuser\Domain\Model\Demand

$demand

Definition at line 131 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\getBackendUserAuthentication(), TYPO3\CMS\Beuser\Controller\BackendUserController\getOnlineBackendUsers(), and TYPO3\CMS\Beuser\Controller\BackendUserController\switchUser().

initializeView()

TYPO3\CMS\Beuser\Controller\BackendUserController::initializeView ( ViewInterface  $view )

protected

Assign default variables to view

Parameters

ViewInterface

$view

Reimplemented from TYPO3\CMS\Extbase\Mvc\Controller\ActionController.

Definition at line 116 of file BackendUserController.php.

References $GLOBALS, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$view, and TYPO3\CMS\Extbase\Mvc\View\ViewInterface\assignMultiple().

initiatePasswordResetAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::initiatePasswordResetAction

(

int

$user

)

Starts the password reset process for a selected user.

Parameters

int

$user

Definition at line 223 of file BackendUserController.php.

References $GLOBALS, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\addFlashMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\forward(), TYPO3\CMS\Core\Messaging\AbstractMessage\OK, and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

onlineAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::onlineAction

(

)

Views all currently logged in BackendUsers and their sessions

Definition at line 159 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\getBackendUserAuthentication(), TYPO3\CMS\Beuser\Controller\BackendUserController\getSessionBackend(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionId().

processRequest()

TYPO3\CMS\Beuser\Controller\BackendUserController::processRequest	(	RequestInterface	$request,
		ResponseInterface	$response
	)

Load and persist module data

Parameters

\TYPO3\CMS\Extbase\Mvc\RequestInterface	$request
\TYPO3\CMS\Extbase\Mvc\ResponseInterface	$response

Exceptions

Reimplemented from TYPO3\CMS\Extbase\Mvc\Controller\ActionController.

Definition at line 99 of file BackendUserController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$request, and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$response.

removeAllFromCompareListAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::removeAllFromCompareListAction

(

)

Removes all backend users from the compare list

Definition at line 282 of file BackendUserController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\redirect().

removeFromCompareListAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::removeFromCompareListAction	(		$uid,
		int	$redirectToCompare = 0
	)

Removes given backend user to the compare list

Parameters

int	$uid
int	$redirectToCompare

Definition at line 268 of file BackendUserController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\redirect().

showAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::showAction

(

int

$uid = 0

)

Parameters

int

$uid

Definition at line 185 of file BackendUserController.php.

switchUser()

TYPO3\CMS\Beuser\Controller\BackendUserController::switchUser (   $switchUser )

protected

Switches to a given user (SU-mode) and then redirects to the start page of the backend to refresh the navigation etc.

Parameters

int

$switchUser

‪BE-user record that will be switched to

Definition at line 315 of file BackendUserController.php.

References $GLOBALS, TYPO3\CMS\Beuser\Controller\BackendUserController\generateListOfMostRecentSwitchedUsers(), TYPO3\CMS\Beuser\Controller\BackendUserController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Beuser\Controller\BackendUserController\getSessionBackend(), TYPO3\CMS\Core\Utility\HttpUtility\redirect(), TYPO3\CMS\Core\Session\Backend\SessionBackendInterface\update(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\writelog(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\indexAction().

terminateBackendUserSessionAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::terminateBackendUserSessionAction ( BackendUser  $backendUser,   $sessionId  )

protected

Terminate BackendUser session and logout corresponding client Redirects to onlineAction with message

Parameters

\TYPO3\CMS\Beuser\Domain\Model\BackendUser	$backendUser
string	$sessionId

Definition at line 298 of file BackendUserController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\addFlashMessage(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\forward(), TYPO3\CMS\Beuser\Controller\BackendUserController\getSessionBackend(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Member Data Documentation

$backendUserGroupRepository

BackendUserGroupRepository TYPO3\CMS\Beuser\Controller\BackendUserController::$backendUserGroupRepository

protected

Definition at line 68 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\__construct().

$backendUserRepository

BackendUserRepository TYPO3\CMS\Beuser\Controller\BackendUserController::$backendUserRepository

protected

Definition at line 64 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\__construct().

$backendUserSessionRepository

BackendUserSessionRepository TYPO3\CMS\Beuser\Controller\BackendUserController::$backendUserSessionRepository

protected

Definition at line 72 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\__construct().

$moduleData

TYPO3 CMS Beuser Domain Model ModuleData TYPO3\CMS\Beuser\Controller\BackendUserController::$moduleData

protected

Definition at line 56 of file BackendUserController.php.

$moduleDataStorageService

ModuleDataStorageService TYPO3\CMS\Beuser\Controller\BackendUserController::$moduleDataStorageService

protected

Definition at line 60 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\__construct().

$userInformationService

UserInformationService TYPO3\CMS\Beuser\Controller\BackendUserController::$userInformationService

protected

Definition at line 76 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\__construct().

RECENT_USERS_LIMIT

const TYPO3\CMS\Beuser\Controller\BackendUserController::RECENT_USERS_LIMIT = 3

Definition at line 52 of file BackendUserController.php.

Referenced by TYPO3\CMS\Beuser\Tests\Unit\Controller\BackendUserControllerTest\generateListOfLatestSwitchedUsersReturnsCorrectAmountAndOrder().