‪TYPO3CMS  9.5
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
TYPO3\CMS\Beuser\Controller\BackendUserController Class Reference
Inheritance diagram for TYPO3\CMS\Beuser\Controller\BackendUserController:
TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait TYPO3\CMS\Extbase\Mvc\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 injectModuleDataStorageService (\TYPO3\CMS\Beuser\Service\ModuleDataStorageService $moduleDataStorageService)
 
 injectBackendUserRepository (\TYPO3\CMS\Beuser\Domain\Repository\BackendUserRepository $backendUserRepository)
 
 injectBackendUserGroupRepository (\TYPO3\CMS\Beuser\Domain\Repository\BackendUserGroupRepository $backendUserGroupRepository)
 
 injectBackendUserSessionRepository (\TYPO3\CMS\Beuser\Domain\Repository\BackendUserSessionRepository $backendUserSessionRepository)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
 indexAction (\TYPO3\CMS\Beuser\Domain\Model\Demand $demand=null)
 
 onlineAction ()
 
 compareAction ()
 
 addToCompareListAction ($uid)
 
 removeFromCompareListAction ($uid)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
 
 injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
 
ControllerContext getControllerContext ()
 
 __construct ()
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
 
bool canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 
 initializeControllerArgumentsBaseValidators ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed __call (string $methodName, array $arguments)
 

Public Attributes

const RECENT_USERS_LIMIT = 3
 

Protected Member Functions

 initializeView (ViewInterface $view)
 
 terminateBackendUserSessionAction (\TYPO3\CMS\Beuser\Domain\Model\BackendUser $backendUser, $sessionId)
 
 switchUser ($switchUser)
 
int[] generateListOfMostRecentSwitchedUsers (int $targetUserUid)
 
 emitSwitchUserSignal (array $targetUser)
 
BackendUserAuthentication getBackendUserAuthentication ()
 
SessionBackendInterface getSessionBackend ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 renderAssetsForRequest ($request)
 
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
string resolveActionMethodName ()
 
 callActionMethod ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
mixed resolveViewObjectName ()
 
 initializeAction ()
 
string errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
string getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
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
 
TYPO3 CMS Beuser Service ModuleDataStorageService $moduleDataStorageService
 
TYPO3 CMS Beuser Domain Repository BackendUserRepository $backendUserRepository
 
TYPO3 CMS Beuser Domain Repository BackendUserGroupRepository $backendUserGroupRepository
 
TYPO3 CMS Beuser Domain Repository BackendUserSessionRepository $backendUserSessionRepository
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Service CacheService $cacheService
 
ViewInterface $view
 
string $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
array $viewFormatToObjectNameMap = array( )
 
string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
TYPO3 CMS Extbase Mvc Request $request
 
TYPO3 CMS Extbase Mvc Response $response
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder $uriBuilder
 
string $extensionName
 
array $settings
 
TYPO3 CMS Extbase Mvc RequestInterface $request
 
TYPO3 CMS Extbase Mvc ResponseInterface $response
 
TYPO3 CMS Extbase Validation ValidatorResolver $validatorResolver
 
TYPO3 CMS Extbase Mvc Controller Arguments $arguments
 
array $supportedRequestTypes = array( \TYPO3\CMS\Extbase\Mvc\Request::class )
 
TYPO3 CMS Extbase Mvc Controller ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Private Attributes

array $deprecatedPublicMethods
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static array getActionMethodParameters ($objectManager)
 

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 31 of file BackendUserController.php.

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 217 of file BackendUserController.php.

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

◆ compareAction()

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

Compare backend users from demand

Definition at line 199 of file BackendUserController.php.

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

◆ emitSwitchUserSignal()

TYPO3\CMS\Beuser\Controller\BackendUserController::emitSwitchUserSignal ( array  $targetUser)
protected

Emit a signal when using the "switch to user" functionality

Parameters
array$targetUser

Definition at line 316 of file BackendUserController.php.

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

◆ 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 290 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 324 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().

◆ getSessionBackend()

SessionBackendInterface TYPO3\CMS\Beuser\Controller\BackendUserController::getSessionBackend ( )
protected
Returns
‪SessionBackendInterface

Definition at line 332 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 ( \TYPO3\CMS\Beuser\Domain\Model\Demand  $demand = null)

Displays all BackendUsers

  • ‪Switch session to different user
Parameters
\TYPO3\CMS\Beuser\Domain\Model\Demand$demand

Definition at line 136 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\getBackendUserAuthentication(), 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 121 of file BackendUserController.php.

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

◆ injectBackendUserGroupRepository()

TYPO3\CMS\Beuser\Controller\BackendUserController::injectBackendUserGroupRepository ( \TYPO3\CMS\Beuser\Domain\Repository\BackendUserGroupRepository  $backendUserGroupRepository)
Parameters
\TYPO3\CMS\Beuser\Domain\Repository\BackendUserGroupRepository$backendUserGroupRepository

Definition at line 84 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\$backendUserGroupRepository.

◆ injectBackendUserRepository()

TYPO3\CMS\Beuser\Controller\BackendUserController::injectBackendUserRepository ( \TYPO3\CMS\Beuser\Domain\Repository\BackendUserRepository  $backendUserRepository)
Parameters
\TYPO3\CMS\Beuser\Domain\Repository\BackendUserRepository$backendUserRepository

Definition at line 76 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\$backendUserRepository.

◆ injectBackendUserSessionRepository()

TYPO3\CMS\Beuser\Controller\BackendUserController::injectBackendUserSessionRepository ( \TYPO3\CMS\Beuser\Domain\Repository\BackendUserSessionRepository  $backendUserSessionRepository)
Parameters
\TYPO3\CMS\Beuser\Domain\Repository\BackendUserSessionRepository$backendUserSessionRepository

Definition at line 92 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\$backendUserSessionRepository.

◆ injectModuleDataStorageService()

TYPO3\CMS\Beuser\Controller\BackendUserController::injectModuleDataStorageService ( \TYPO3\CMS\Beuser\Service\ModuleDataStorageService  $moduleDataStorageService)
Parameters
\TYPO3\CMS\Beuser\Service\ModuleDataStorageService$moduleDataStorageService

Definition at line 68 of file BackendUserController.php.

References TYPO3\CMS\Beuser\Controller\BackendUserController\$moduleDataStorageService.

◆ onlineAction()

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

Views all currently logged in BackendUsers and their sessions

Definition at line 173 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 ( \TYPO3\CMS\Extbase\Mvc\RequestInterface  $request,
\TYPO3\CMS\Extbase\Mvc\ResponseInterface  $response 
)

Load and persist module data

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

Definition at line 104 of file BackendUserController.php.

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

◆ removeFromCompareListAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::removeFromCompareListAction (   $uid)

Removes given backend user to the compare list

Parameters
int$uid

Definition at line 229 of file BackendUserController.php.

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

◆ 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
string$switchUser‪BE-user record that will be switched to

Definition at line 260 of file BackendUserController.php.

References $GLOBALS, TYPO3\CMS\Beuser\Controller\BackendUserController\emitSwitchUserSignal(), 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(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

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

◆ terminateBackendUserSessionAction()

TYPO3\CMS\Beuser\Controller\BackendUserController::terminateBackendUserSessionAction ( \TYPO3\CMS\Beuser\Domain\Model\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 243 of file BackendUserController.php.

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

Member Data Documentation

◆ $backendUserGroupRepository

TYPO3 CMS Beuser Domain Repository BackendUserGroupRepository TYPO3\CMS\Beuser\Controller\BackendUserController::$backendUserGroupRepository
protected

Definition at line 59 of file BackendUserController.php.

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

◆ $backendUserRepository

TYPO3 CMS Beuser Domain Repository BackendUserRepository TYPO3\CMS\Beuser\Controller\BackendUserController::$backendUserRepository
protected

Definition at line 55 of file BackendUserController.php.

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

◆ $backendUserSessionRepository

TYPO3 CMS Beuser Domain Repository BackendUserSessionRepository TYPO3\CMS\Beuser\Controller\BackendUserController::$backendUserSessionRepository
protected

Definition at line 63 of file BackendUserController.php.

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

◆ $deprecatedPublicMethods

array TYPO3\CMS\Beuser\Controller\BackendUserController::$deprecatedPublicMethods
private
Initial value:
= array(
'initializeView' => 'Using BackendUserController::initializeView() is deprecated and will not be possible anymore in TYPO3 v10.0.',
)

Definition at line 36 of file BackendUserController.php.

◆ $moduleData

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

Definition at line 47 of file BackendUserController.php.

◆ $moduleDataStorageService

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

Definition at line 51 of file BackendUserController.php.

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

◆ RECENT_USERS_LIMIT

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

Definition at line 43 of file BackendUserController.php.

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