TYPO3 11.5 API: ListController

ListController extends AbstractModuleController

Controller for extension listings (TER or local extensions)

Internal

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

Constants

TRIGGER_RefreshModuleMenu = 'refreshModuleMenu'
TRIGGER_RefreshTopbar = 'refreshTopbar'

Properties

$actionMethodName : string: Name of the action method
$arguments : Arguments
$configurationManager : ConfigurationManagerInterface
$controllerContext : ControllerContext
$defaultViewObjectName : string: The default view object to use if none of the resolved views can render a response for the current request.
$dependencyUtility : DependencyUtility
$errorMethodName : string: Name of the special error action method which is called in case of errors
$eventDispatcher : EventDispatcherInterface
$extensionRepository : ExtensionRepository
$hashService : HashService
$iconFactory : IconFactory
$listUtility : ListUtility
$moduleTemplateFactory : ModuleTemplateFactory
$mvcPropertyMappingConfigurationService : MvcPropertyMappingConfigurationService
$objectManager : ObjectManagerInterface
$pageRenderer : PageRenderer
$reflectionService : ReflectionService
$request : Request: The current request.
$responseFactory : ResponseFactoryInterface
$settings : array<string|int, mixed>: Contains the settings of the current extension
$signalSlotDispatcher : Dispatcher
$streamFactory : StreamFactoryInterface
$triggerArguments : array<string|int, mixed>
$uriBuilder : UriBuilder
$validatorResolver : ValidatorResolver
$view : ViewInterface: The current view, as resolved by resolveView()

Methods

__construct() : mixed
addFlashMessage() : mixed: Creates a Message object and adds it to the FlashMessageQueue.
distributionsAction() : ResponseInterface: Action for listing all possible distributions
forward() : never: Forwards the request to another action and / or controller.
getControllerContext() : ControllerContext
indexAction() : ResponseInterface: Shows list of extensions present in the system
initializeAction() : mixed: Add the needed JavaScript files for all actions
initializeControllerArgumentsBaseValidators() : mixed: Collects the base validators which were defined for the data type of each controller argument and adds them to the argument's validator chain.
injectConfigurationManager() : mixed
injectEventDispatcher() : void
injectHashService() : mixed
injectInternalExtensionService() : void
injectInternalFlashMessageService() : void
injectModuleTemplateFactory() : mixed
injectMvcPropertyMappingConfigurationService() : mixed
injectObjectManager() : mixed: Injects the object manager
injectPropertyMapper() : void
injectReflectionService() : mixed
injectResponseFactory() : mixed
injectSignalSlotDispatcher() : mixed
injectStreamFactory() : mixed
injectValidatorResolver() : mixed
injectViewResolver() : mixed
processRequest() : ResponseInterface: Handles an incoming request and returns a response object
showAllVersionsAction() : ResponseInterface: Shows all versions of a specific extension
terAction() : ResponseInterface: Shows extensions from TER Either all extensions or depending on a search param
throwStatus() : never: Sends the specified HTTP status immediately and only stops to run back through the middleware stack.
unresolvedDependenciesAction() : ResponseInterface: Shows a list of unresolved dependency errors with the possibility to bypass the dependency check
addBaseUriIfNecessary() : string: Adds the base uri if not already in place.
addComposerModeNotification() : mixed: Adds an information about composer mode
addErrorFlashMessage() : mixed: If an error occurred during this request, this adds a flash message describing the error to the flash message container.
buildControllerContext() : ControllerContext: Initialize the controller context
callActionMethod() : ResponseInterface: Calls the specified action method and passes the arguments.
enrichExtensionsWithViewInformation() : array<string|int, mixed>
errorAction() : ResponseInterface: A special action which is called if the originally intended action could not be called, for example if the arguments were not valid.
extensionsWithUpdate() : array<string|int, mixed>
forwardToReferringRequest() : ResponseInterface|null: If information on the request before the current request was sent, this method forwards back to the originating request. This effectively ends processing of the current request, so do not call this method before you have finished the necessary business logic!
getBackendUserAuthentication() : BackendUserAuthentication
getBackendUserFilter() : string
getErrorFlashMessage() : string|bool: A template method for displaying custom error flash messages, or to display no flash message at all on errors. Override this to customize the flash message in your action controller.
getFlashMessageQueue() : FlashMessageQueue: todo: As soon as the incoming request contains the compiled plugin namespace, extbase will offer a trait to create a flash message identifier from the current request. Users then should inject the flash message service themselves if needed.
getFlattenedValidationErrorMessage() : string: Returns a string with a basic error message about validation failure.
getViewProperty() : array<string|int, mixed>: Handles the path resolving for *rootPath(s)
handleTriggerArguments() : mixed: Handles trigger arguments, e.g. refreshing the module menu widget if an extension with backend modules has been enabled or disabled.
htmlResponse() : ResponseInterface: Returns a response object with either the given html string or the current rendered view as content.
initializeActionMethodArguments() : mixed: Implementation of the arguments initialization in the action controller: Automatically registers arguments of the current action
initializeActionMethodValidators() : mixed: Adds the needed validators to the Arguments:
initializeModuleTemplate() : ModuleTemplate: Generates the action menu
initializeView() : mixed: Initializes the view before invoking an action method.
jsonResponse() : ResponseInterface: Returns a response object with either the given json string or the current rendered view as content. Mainly to be used for actions / controllers using the JsonView.
mapRequestArgumentsToControllerArguments() : mixed: Maps arguments delivered by the request object to the local controller arguments.
redirect() : never: Redirects the request to another action and / or controller.
redirectToUri() : never: Redirects the web request to another uri.
registerDocHeaderButtons() : ModuleTemplate: Registers the Icons into the docheader
renderAssetsForRequest() : mixed: Method which initializes assets that should be attached to the response for the given $request, which contains parameters that an override can use to determine which assets to add via PageRenderer.
resolveActionMethodName() : string: Resolves and checks the current action method name
resolveView() : ViewInterface: Resolve view and initialize the general view-variables extensionName, controllerName and actionName based on the request object
saveBackendUserFilter() : void
setViewConfiguration() : mixed
translate() : string: Translation shortcut

TRIGGER_RefreshModuleMenu


    public
        mixed
    TRIGGER_RefreshModuleMenu
    = 'refreshModuleMenu'

TRIGGER_RefreshTopbar


    public
        mixed
    TRIGGER_RefreshTopbar
    = 'refreshTopbar'

$actionMethodName

Name of the action method


    protected
        string
    $actionMethodName
     = 'indexAction'

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$arguments


    protected
        Arguments
    $arguments

Arguments passed to the controller

$configurationManager


    protected
        ConfigurationManagerInterface
    $configurationManager

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$controllerContext

Deprecated

since v11, will be removed with v12.


    protected
        ControllerContext
    $controllerContext

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$defaultViewObjectName

The default view object to use if none of the resolved views can render a response for the current request.


    protected
        string
    $defaultViewObjectName
     = \TYPO3\CMS\Fluid\View\TemplateView::class

$dependencyUtility


    protected
        DependencyUtility
    $dependencyUtility

$errorMethodName

Name of the special error action method which is called in case of errors


    protected
        string
    $errorMethodName
     = 'errorAction'

$eventDispatcher


    protected
        EventDispatcherInterface
    $eventDispatcher

$extensionRepository


    protected
        ExtensionRepository
    $extensionRepository

$hashService


    protected
        HashService
    $hashService

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$iconFactory


    protected
        IconFactory
    $iconFactory

$listUtility


    protected
        ListUtility
    $listUtility

$moduleTemplateFactory


    protected
        ModuleTemplateFactory
    $moduleTemplateFactory

$mvcPropertyMappingConfigurationService


    protected
        MvcPropertyMappingConfigurationService
    $mvcPropertyMappingConfigurationService

$objectManager

Deprecated

since v11, will be removed in v12


    protected
        ObjectManagerInterface
    $objectManager

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$pageRenderer


    protected
        PageRenderer
    $pageRenderer

$reflectionService


    protected
        ReflectionService
    $reflectionService

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$request

The current request.


    protected
        Request
    $request

$responseFactory


    protected
        ResponseFactoryInterface
    $responseFactory

$settings

Contains the settings of the current extension


    protected
        array<string|int, mixed>
    $settings

$signalSlotDispatcher


    protected
        Dispatcher
    $signalSlotDispatcher

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$streamFactory


    protected
        StreamFactoryInterface
    $streamFactory

$triggerArguments


    protected
        array<string|int, mixed>
    $triggerArguments
     = [self::TRIGGER_RefreshModuleMenu, self::TRIGGER_RefreshTopbar]

$uriBuilder


    protected
        UriBuilder
    $uriBuilder

$validatorResolver


    protected
        ValidatorResolver
    $validatorResolver

Internal

only to be used within Extbase, not part of TYPO3 Core API.

$view

The current view, as resolved by resolveView()


    protected
        ViewInterface
    $view

__construct()


    public
                    __construct(PageRenderer $pageRenderer, ExtensionRepository $extensionRepository, ListUtility $listUtility, DependencyUtility $dependencyUtility, IconFactory $iconFactory) : mixed

Parameters

$pageRenderer : PageRenderer
$extensionRepository : ExtensionRepository
$listUtility : ListUtility
$dependencyUtility : DependencyUtility
$iconFactory : IconFactory

addFlashMessage()

Creates a Message object and adds it to the FlashMessageQueue.


    public
                    addFlashMessage(string $messageBody[, string $messageTitle = '' ][, int $severity = AbstractMessage::OK ][, bool $storeInSession = true ]) : mixed

Parameters

$messageBody : string: The message
$messageTitle : string = '': Optional message title
$severity : int = AbstractMessage::OK: Optional severity, must be one of \TYPO3\CMS\Core\Messaging\FlashMessage constants
$storeInSession : bool = true: Optional, defines whether the message should be stored in the session (default) or not

distributionsAction()

Action for listing all possible distributions


    public
                    distributionsAction([bool $showUnsuitableDistributions = false ]) : ResponseInterface

Parameters

$showUnsuitableDistributions : bool = false

Return values

ResponseInterface

forward()

Forwards the request to another action and / or controller.


    public
                    forward(string|null $actionName[, string|null $controllerName = null ][, string|null $extensionName = null ][, array<string|int, mixed>|null $arguments = null ]) : never

Deprecated

since TYPO3 11.0, will be removed in 12.0

Request is directly transferred to the other action / controller without the need for a new request.

Parameters

$actionName : string|null: Name of the action to forward to
$controllerName : string|null = null: Unqualified object name of the controller to forward to. If not specified, the current controller is used.
$extensionName : string|null = null: Name of the extension containing the controller to forward to. If not specified, the current extension is assumed.
$arguments : array<string|int, mixed>|null = null: Arguments to pass to the target action

Return values

never

getControllerContext()


    public
                    getControllerContext() : ControllerContext

Deprecated

since v11, will be removed with v12.

Return values

ControllerContext

indexAction()

Shows list of extensions present in the system


    public
                    indexAction() : ResponseInterface

Return values

ResponseInterface

initializeAction()

Add the needed JavaScript files for all actions


    public
                    initializeAction() : mixed

initializeControllerArgumentsBaseValidators()

Collects the base validators which were defined for the data type of each controller argument and adds them to the argument's validator chain.


    public
                    initializeControllerArgumentsBaseValidators() : mixed

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectConfigurationManager()


    public
                    injectConfigurationManager(ConfigurationManagerInterface $configurationManager) : mixed

Parameters

$configurationManager : ConfigurationManagerInterface

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectEventDispatcher()


    public
                    injectEventDispatcher(EventDispatcherInterface $eventDispatcher) : void

Parameters

$eventDispatcher : EventDispatcherInterface

injectHashService()


    public
                    injectHashService(HashService $hashService) : mixed

Parameters

$hashService : HashService

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectInternalExtensionService()


    public
        final            injectInternalExtensionService(ExtensionService $extensionService) : void

Parameters

$extensionService : ExtensionService

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectInternalFlashMessageService()


    public
        final            injectInternalFlashMessageService(FlashMessageService $flashMessageService) : void

Parameters

$flashMessageService : FlashMessageService

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectModuleTemplateFactory()


    public
                    injectModuleTemplateFactory(ModuleTemplateFactory $moduleTemplateFactory) : mixed

Parameters

$moduleTemplateFactory : ModuleTemplateFactory

injectMvcPropertyMappingConfigurationService()


    public
                    injectMvcPropertyMappingConfigurationService(MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService) : mixed

Parameters

$mvcPropertyMappingConfigurationService : MvcPropertyMappingConfigurationService

injectObjectManager()

Injects the object manager


    public
                    injectObjectManager(ObjectManagerInterface $objectManager) : mixed

Deprecated

since v11, will be removed in v12

Parameters

$objectManager : ObjectManagerInterface

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectPropertyMapper()


    public
                    injectPropertyMapper(PropertyMapper $propertyMapper) : void

Parameters

$propertyMapper : PropertyMapper

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectReflectionService()


    public
                    injectReflectionService(ReflectionService $reflectionService) : mixed

Parameters

$reflectionService : ReflectionService

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectResponseFactory()


    public
        final            injectResponseFactory(ResponseFactoryInterface $responseFactory) : mixed

Parameters

$responseFactory : ResponseFactoryInterface

injectSignalSlotDispatcher()


    public
                    injectSignalSlotDispatcher(Dispatcher $signalSlotDispatcher) : mixed

Deprecated

since v11, will be removed in v12

Parameters

$signalSlotDispatcher : Dispatcher

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectStreamFactory()


    public
        final            injectStreamFactory(StreamFactoryInterface $streamFactory) : mixed

Parameters

$streamFactory : StreamFactoryInterface

injectValidatorResolver()


    public
                    injectValidatorResolver(ValidatorResolver $validatorResolver) : mixed

Parameters

$validatorResolver : ValidatorResolver

Internal

only to be used within Extbase, not part of TYPO3 Core API.

injectViewResolver()


    public
                    injectViewResolver(ViewResolverInterface $viewResolver) : mixed

Parameters

$viewResolver : ViewResolverInterface

Internal

only to be used within Extbase, not part of TYPO3 Core API.

processRequest()

Handles an incoming request and returns a response object


    public
                    processRequest(RequestInterface $request) : ResponseInterface

Parameters

$request : RequestInterface: The request object

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

ResponseInterface

showAllVersionsAction()

Shows all versions of a specific extension


    public
                    showAllVersionsAction(string $extensionKey) : ResponseInterface

Parameters

$extensionKey : string

Return values

ResponseInterface

terAction()

Shows extensions from TER Either all extensions or depending on a search param


    public
                    terAction([string $search = '' ][, int $currentPage = 1 ]) : ResponseInterface

Parameters

$search : string = ''
$currentPage : int = 1

Return values

ResponseInterface

throwStatus()

Sends the specified HTTP status immediately and only stops to run back through the middleware stack.


    public
                    throwStatus(int $statusCode[, string $statusMessage = null ][, string $content = null ]) : never

Note: If any other plugin or content or hook is used within a frontend request, this is skipped by design.

Parameters

$statusCode : int: The HTTP status code
$statusMessage : string = null: A custom HTTP status message
$content : string = null: Body content which further explains the status

Return values

never

unresolvedDependenciesAction()

Shows a list of unresolved dependency errors with the possibility to bypass the dependency check


    public
                    unresolvedDependenciesAction(string $extensionKey) : ResponseInterface

Parameters

$extensionKey : string

Return values

ResponseInterface

addBaseUriIfNecessary()

Adds the base uri if not already in place.


    protected
                    addBaseUriIfNecessary(string $uri) : string

Parameters

$uri : string: The URI

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

string

addComposerModeNotification()

Adds an information about composer mode


    protected
                    addComposerModeNotification() : mixed

addErrorFlashMessage()

If an error occurred during this request, this adds a flash message describing the error to the flash message container.


    protected
                    addErrorFlashMessage() : mixed

Internal

only to be used within Extbase, not part of TYPO3 Core API.

buildControllerContext()

Initialize the controller context


    protected
                    buildControllerContext() : ControllerContext

Deprecated

since v11, will be removed with v12.

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

ControllerContext —

ControllerContext to be passed to the view

callActionMethod()

Calls the specified action method and passes the arguments.


    protected
                    callActionMethod(RequestInterface $request) : ResponseInterface

If the action returns a string, it is appended to the content in the response object. If the action doesn't return anything and a valid view exists, the view is rendered automatically.

Parameters

$request : RequestInterface

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

ResponseInterface

enrichExtensionsWithViewInformation()


    protected
                    enrichExtensionsWithViewInformation(array<string|int, mixed> $availableAndInstalledExtensions, bool $isComposerMode) : array<string|int, mixed>

Parameters

$availableAndInstalledExtensions : array<string|int, mixed>
$isComposerMode : bool

Return values

array<string|int, mixed>

errorAction()

A special action which is called if the originally intended action could not be called, for example if the arguments were not valid.


    protected
                    errorAction() : ResponseInterface

The default implementation sets a flash message, request errors and forwards back to the originating action. This is suitable for most actions dealing with form input.

We clear the page cache by default on an error as well, as we need to make sure the data is re-evaluated when the user changes something.

Return values

ResponseInterface

extensionsWithUpdate()


    protected
                    extensionsWithUpdate(array<string|int, mixed> $availableAndInstalledExtensions) : array<string|int, mixed>

Parameters

$availableAndInstalledExtensions : array<string|int, mixed>

Return values

array<string|int, mixed>

forwardToReferringRequest()

If information on the request before the current request was sent, this method forwards back to the originating request. This effectively ends processing of the current request, so do not call this method before you have finished the necessary business logic!


    protected
                    forwardToReferringRequest() : ResponseInterface|null

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

ResponseInterface|null

getBackendUserAuthentication()


    protected
                    getBackendUserAuthentication() : BackendUserAuthentication

Return values

BackendUserAuthentication

getBackendUserFilter()


    protected
                    getBackendUserFilter() : string

Return values

string

getErrorFlashMessage()

A template method for displaying custom error flash messages, or to display no flash message at all on errors. Override this to customize the flash message in your action controller.


    protected
                    getErrorFlashMessage() : string|bool

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

string|bool —

The flash message or FALSE if no flash message should be set

getFlashMessageQueue()

todo: As soon as the incoming request contains the compiled plugin namespace, extbase will offer a trait to create a flash message identifier from the current request. Users then should inject the flash message service themselves if needed.


    protected
                    getFlashMessageQueue([string|null $identifier = null ]) : FlashMessageQueue

Parameters

$identifier : string|null = null

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

FlashMessageQueue

getFlattenedValidationErrorMessage()

Returns a string with a basic error message about validation failure.


    protected
                    getFlattenedValidationErrorMessage() : string

We may add all validation error messages to a log file in the future, but for security reasons (@see #54074) we do not return these here.

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

string

getViewProperty()

Handles the path resolving for *rootPath(s)


    protected
                    getViewProperty(array<string|int, mixed> $extbaseFrameworkConfiguration, string $setting) : array<string|int, mixed>

numerical arrays get ordered by key ascending

Parameters

$extbaseFrameworkConfiguration : array<string|int, mixed>
$setting : string: parameter name from TypoScript

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

array<string|int, mixed>

handleTriggerArguments()

Handles trigger arguments, e.g. refreshing the module menu widget if an extension with backend modules has been enabled or disabled.


    protected
                    handleTriggerArguments() : mixed

htmlResponse()

Returns a response object with either the given html string or the current rendered view as content.


    protected
                    htmlResponse([string|null $html = null ]) : ResponseInterface

Parameters

$html : string|null = null

Return values

ResponseInterface

initializeActionMethodArguments()

Implementation of the arguments initialization in the action controller: Automatically registers arguments of the current action


    protected
                    initializeActionMethodArguments() : mixed

Don't override this method - use initializeAction() instead.

Internal

only to be used within Extbase, not part of TYPO3 Core API.

initializeActionMethodValidators()

Adds the needed validators to the Arguments:


    protected
                    initializeActionMethodValidators() : mixed

Validators checking the data type from the @param annotation
Custom validators specified with validate annotations.
Model-based validators (validate annotations in the model)
Custom model validator classes

Internal

only to be used within Extbase, not part of TYPO3 Core API.

initializeModuleTemplate()

Generates the action menu


    protected
                    initializeModuleTemplate(ServerRequestInterface $request) : ModuleTemplate

Parameters

$request : ServerRequestInterface

Return values

ModuleTemplate

initializeView()

Initializes the view before invoking an action method.


    protected
                    initializeView(ViewInterface $view) : mixed

Deprecated

since v11, will be removed in v12: Drop method along with extbase ViewInterface.

Override this method to solve assign variables common for all actions or prepare the view in another way before the action is called.

Parameters

$view : ViewInterface: The view to be initialized

jsonResponse()

Returns a response object with either the given json string or the current rendered view as content. Mainly to be used for actions / controllers using the JsonView.


    protected
                    jsonResponse([string|null $json = null ]) : ResponseInterface

Parameters

$json : string|null = null

Return values

ResponseInterface

mapRequestArgumentsToControllerArguments()

Maps arguments delivered by the request object to the local controller arguments.


    protected
                    mapRequestArgumentsToControllerArguments() : mixed

Internal

only to be used within Extbase, not part of TYPO3 Core API.

redirect()

Redirects the request to another action and / or controller.


    protected
                    redirect(string|null $actionName[, string|null $controllerName = null ][, string|null $extensionName = null ][, array<string|int, mixed>|null $arguments = null ][, int|null $pageUid = null ][, null $_ = null ][, int $statusCode = 303 ]) : never

Redirect will be sent to the client which then performs another request to the new URI.

Parameters

$actionName : string|null: Name of the action to forward to
$controllerName : string|null = null: Unqualified object name of the controller to forward to. If not specified, the current controller is used.
$extensionName : string|null = null: Name of the extension containing the controller to forward to. If not specified, the current extension is assumed.
$arguments : array<string|int, mixed>|null = null: Arguments to pass to the target action
$pageUid : int|null = null: Target page uid. If NULL, the current page uid is used
$_ : null = null: (optional) Unused
$statusCode : int = 303: (optional) The HTTP status code for the redirect. Default is "303 See Other

Return values

never

redirectToUri()

Redirects the web request to another uri.


    protected
                    redirectToUri(mixed $uri[, null $_ = null ][, int $statusCode = 303 ]) : never

Parameters

$uri : mixed: A string representation of a URI
$_ : null = null: (optional) Unused
$statusCode : int = 303: (optional) The HTTP status code for the redirect. Default is "303 See Other"

Return values

never

registerDocHeaderButtons()

Registers the Icons into the docheader


    protected
                    registerDocHeaderButtons(ModuleTemplate $moduleTemplate) : ModuleTemplate

Parameters

$moduleTemplate : ModuleTemplate

Return values

ModuleTemplate

renderAssetsForRequest()

Method which initializes assets that should be attached to the response for the given $request, which contains parameters that an override can use to determine which assets to add via PageRenderer.


    protected
                    renderAssetsForRequest(RequestInterface $request) : mixed

This default implementation will attempt to render the sections "HeaderAssets" and "FooterAssets" from the template that is being rendered, inserting the rendered content into either page header or footer, as appropriate. Both sections are optional and can be used one or both in combination.

You can add assets with this method without worrying about duplicates, if for example you do this in a plugin that gets used multiple time on a page.

Parameters

$request : RequestInterface

Internal

only to be used within Extbase, not part of TYPO3 Core API.

resolveActionMethodName()

Resolves and checks the current action method name


    protected
                    resolveActionMethodName() : string

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Return values

string —

Method name of the current action

resolveView()

Resolve view and initialize the general view-variables extensionName, controllerName and actionName based on the request object


    protected
                    resolveView() : ViewInterface

Return values

ViewInterface

saveBackendUserFilter()


    protected
                    saveBackendUserFilter(string $filter) : void

Parameters

$filter : string

setViewConfiguration()


    protected
                    setViewConfiguration(ViewInterface $view) : mixed

Parameters

$view : ViewInterface

Internal

only to be used within Extbase, not part of TYPO3 Core API.

translate()

Translation shortcut


    protected
                    translate(string $key[, array<string|int, mixed>|null $arguments = null ]) : string

Parameters

$key : string
$arguments : array<string|int, mixed>|null = null

Return values

string

ListController extends AbstractModuleController

Table of Contents

Constants

Properties

Methods

Constants

TRIGGER_RefreshModuleMenu

TRIGGER_RefreshTopbar

Properties

$actionMethodName

$arguments

$configurationManager

$controllerContext

$defaultViewObjectName

$dependencyUtility

$errorMethodName

$eventDispatcher

$extensionRepository

$hashService

$iconFactory

$listUtility

$moduleTemplateFactory

$mvcPropertyMappingConfigurationService

$objectManager

$pageRenderer

$reflectionService

$request

Tags

$responseFactory

$settings

$signalSlotDispatcher

$streamFactory

$triggerArguments

$uriBuilder

$validatorResolver

$view

Tags

Methods

__construct()

Parameters

addFlashMessage()

Parameters

Tags

distributionsAction()

Parameters

Return values

forward()

Parameters

Tags

Return values

getControllerContext()

Return values

indexAction()

Return values

initializeAction()

initializeControllerArgumentsBaseValidators()

injectConfigurationManager()

Parameters

injectEventDispatcher()

Parameters

injectHashService()

Parameters

injectInternalExtensionService()

Parameters

injectInternalFlashMessageService()

Parameters

injectModuleTemplateFactory()

Parameters

injectMvcPropertyMappingConfigurationService()

Parameters

injectObjectManager()

Parameters

injectPropertyMapper()

Parameters

injectReflectionService()

Parameters

injectResponseFactory()

Parameters

injectSignalSlotDispatcher()

Parameters