‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Adminpanel\Controller\MainController Class Reference
Inheritance diagram for TYPO3\CMS\Adminpanel\Controller\MainController:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 __construct (ModuleLoader $moduleLoader=null, UriBuilder $uriBuilder=null, ConfigurationService $configurationService=null)
 
 initialize (ServerRequestInterface $request)
 
string render (ServerRequestInterface $request)
 
 storeData (ServerRequestInterface $request)
 

Protected Member Functions

string generateBackendUrl (string $route)
 
 initializeModules (ServerRequestInterface $request, array $modules)
 
ModuleDataStorageCollection storeDataPerModule (ServerRequestInterface $request, array $modules, ModuleDataStorageCollection $data)
 

Protected Attributes

TYPO3 CMS Adminpanel ModuleApi ModuleInterface[] $modules = array( )
 
ModuleLoader $moduleLoader
 
UriBuilder $uriBuilder
 
ConfigurationService $configurationService
 
array $adminPanelModuleConfiguration
 

Detailed Description

Main controller for the admin panel

Definition at line 44 of file MainController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Adminpanel\Controller\MainController::__construct ( ModuleLoader  $moduleLoader = null,
UriBuilder  $uriBuilder = null,
ConfigurationService  $configurationService = null 
)
Parameters
ModuleLoader$moduleLoader
UriBuilder$uriBuilder
ConfigurationService$configurationService

Definition at line 71 of file MainController.php.

References TYPO3\CMS\Adminpanel\Controller\MainController\$configurationService, $GLOBALS, TYPO3\CMS\Adminpanel\Controller\MainController\$moduleLoader, and TYPO3\CMS\Adminpanel\Controller\MainController\$uriBuilder.

Member Function Documentation

◆ generateBackendUrl()

string TYPO3\CMS\Adminpanel\Controller\MainController::generateBackendUrl ( string  $route)
protected

Generate a url to a backend route

Parameters
string$route
Returns
‪string

Definition at line 186 of file MainController.php.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\render().

◆ initialize()

TYPO3\CMS\Adminpanel\Controller\MainController::initialize ( ServerRequestInterface  $request)

Initializes settings for the admin panel.

Parameters
ServerRequestInterface$request

Definition at line 89 of file MainController.php.

References TYPO3\CMS\Adminpanel\Controller\MainController\initializeModules(), and TYPO3\CMS\Adminpanel\Utility\StateUtility\isActivatedForUser().

◆ initializeModules()

TYPO3\CMS\Adminpanel\Controller\MainController::initializeModules ( ServerRequestInterface  $request,
array  $modules 
)
protected
Parameters
\Psr\Http\Message\ServerRequestInterface$request
\TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface[]$modules

Definition at line 195 of file MainController.php.

References TYPO3\CMS\Adminpanel\Controller\MainController\$modules.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\initialize().

◆ render()

string TYPO3\CMS\Adminpanel\Controller\MainController::render ( ServerRequestInterface  $request)

Renders the admin panel - Called in PSR-15 Middleware

See also
‪\TYPO3\CMS\Adminpanel\Middleware\AdminPanelRenderer
Parameters
\Psr\Http\Message\ServerRequestInterface$request
Returns
‪string

Definition at line 107 of file MainController.php.

References TYPO3\CMS\Adminpanel\Controller\MainController\generateBackendUrl(), TYPO3\CMS\Adminpanel\Utility\ResourceUtility\getAdditionalResourcesForModules(), TYPO3\CMS\Adminpanel\Utility\ResourceUtility\getResources(), and TYPO3\CMS\Adminpanel\Utility\StateUtility\isOpen().

◆ storeData()

TYPO3\CMS\Adminpanel\Controller\MainController::storeData ( ServerRequestInterface  $request)

Stores data for admin panel in cache - Called in PSR-15 Middleware

See also
‪\TYPO3\CMS\Adminpanel\Middleware\AdminPanelDataPersister
Parameters
\Psr\Http\Message\ServerRequestInterface$request
Exceptions

Definition at line 166 of file MainController.php.

References TYPO3\CMS\Adminpanel\Utility\StateUtility\isOpen(), and TYPO3\CMS\Adminpanel\Controller\MainController\storeDataPerModule().

◆ storeDataPerModule()

ModuleDataStorageCollection TYPO3\CMS\Adminpanel\Controller\MainController::storeDataPerModule ( ServerRequestInterface  $request,
array  $modules,
ModuleDataStorageCollection  $data 
)
protected
Parameters
\Psr\Http\Message\ServerRequestInterface$request
\TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface[]$modules
ModuleDataStorageCollection$data
Returns
‪ModuleDataStorageCollection

Definition at line 219 of file MainController.php.

References TYPO3\CMS\Adminpanel\Controller\MainController\$modules, and TYPO3\CMS\Adminpanel\ModuleApi\ModuleDataStorageCollection\addModuleData().

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\storeData().

Member Data Documentation

◆ $adminPanelModuleConfiguration

array TYPO3\CMS\Adminpanel\Controller\MainController::$adminPanelModuleConfiguration
protected

Definition at line 64 of file MainController.php.

◆ $configurationService

ConfigurationService TYPO3\CMS\Adminpanel\Controller\MainController::$configurationService
protected

Definition at line 60 of file MainController.php.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\__construct().

◆ $moduleLoader

ModuleLoader TYPO3\CMS\Adminpanel\Controller\MainController::$moduleLoader
protected

Definition at line 52 of file MainController.php.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\__construct().

◆ $modules

TYPO3 CMS Adminpanel ModuleApi ModuleInterface [] TYPO3\CMS\Adminpanel\Controller\MainController::$modules = array( )
protected

Definition at line 48 of file MainController.php.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\initializeModules(), and TYPO3\CMS\Adminpanel\Controller\MainController\storeDataPerModule().

◆ $uriBuilder

UriBuilder TYPO3\CMS\Adminpanel\Controller\MainController::$uriBuilder
protected

Definition at line 56 of file MainController.php.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\__construct().