TYPO3 12.4 API: ActionController

ActionController extends AbstractController

Controller for handling extension related actions like installing, removing, downloading of data or files.

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
$defaultViewObjectName : string: The default view object to use if none of the resolved views can render a response for the current request.
$errorMethodName : string: Name of the special error action method which is called in case of errors
$eventDispatcher : EventDispatcherInterface
$hashService : HashService
$installUtility : InstallUtility
$managementService : ExtensionManagementService
$moduleTemplateFactory : ModuleTemplateFactory
$mvcPropertyMappingConfigurationService : MvcPropertyMappingConfigurationService
$reflectionService : ReflectionService
$registry : Registry
$request : RequestInterface: The current request.
$responseFactory : ResponseFactoryInterface
$settings : array<string|int, mixed>: Contains the settings of the current extension
$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.
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
injectPropertyMapper() : void
injectReflectionService() : mixed
injectResponseFactory() : mixed
injectStreamFactory() : mixed
injectValidatorResolver() : mixed
injectViewResolver() : mixed
installExtensionWithoutSystemDependencyCheckAction() : ResponseInterface: Install an extension and omit dependency checking
processRequest() : ResponseInterface: Handles an incoming request and returns a response object
throwStatus() : never: Sends the specified HTTP status immediately and only stops to run back through the middleware stack.
addBaseUriIfNecessary() : string: Adds the base uri if not already in place.
addErrorFlashMessage() : mixed: If an error occurred during this request, this adds a flash message describing the error to the flash message container.
callActionMethod() : ResponseInterface: Calls the specified action method and passes the arguments.
createZipFileFromExtension() : string: Create a zip file from an extension
downloadExtensionZipAction() : ResponseInterface: Download an extension as a zip file
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.
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!
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.
handleTriggerArguments() : void: 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.
initializeAction() : mixed: Initializes the controller before invoking an action method.
initializeActionMethodArguments() : void: Implementation of the arguments initialization in the action controller: Automatically registers arguments of the current action
initializeActionMethodValidators() : void: Adds the needed validators to the Arguments:
initializeModuleTemplate() : ModuleTemplate: Generates the action menu. Helper used in action that render backend moduleTemplate views and not just redirect or response download things.
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() : ResponseInterface: Redirects the request to another action and / or controller.
redirectToUri() : ResponseInterface: Redirects the web request to another uri.
reloadExtensionDataAction() : ResponseInterface: Reloads the static SQL data of an extension
removeExtensionAction() : ResponseInterface: Remove an extension (if it is still installed, uninstall it first)
renderAssetsForRequest() : void: 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: Prepares a view for the current action.
setViewConfiguration() : void
toggleExtensionInstallationStateAction() : ResponseInterface: Toggle extension installation state action
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.

$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

$errorMethodName

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


    protected
        string
    $errorMethodName
     = 'errorAction'

$eventDispatcher


    protected
        EventDispatcherInterface
    $eventDispatcher

$hashService


    protected
        HashService
    $hashService

Internal

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

$installUtility read-only


    protected
        InstallUtility
    $installUtility

$managementService read-only


    protected
        ExtensionManagementService
    $managementService

$moduleTemplateFactory


    protected
        ModuleTemplateFactory
    $moduleTemplateFactory

$mvcPropertyMappingConfigurationService


    protected
        MvcPropertyMappingConfigurationService
    $mvcPropertyMappingConfigurationService

$reflectionService


    protected
        ReflectionService
    $reflectionService

Internal

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

$registry read-only


    protected
        Registry
    $registry

$request

The current request.


    protected
        RequestInterface
    $request

$responseFactory


    protected
        ResponseFactoryInterface
    $responseFactory

$settings

Contains the settings of the current extension


    protected
        array<string|int, mixed>
    $settings

$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(InstallUtility $installUtility, ExtensionManagementService $managementService, Registry $registry) : mixed

Parameters

$installUtility : InstallUtility
$managementService : ExtensionManagementService
$registry : Registry

addFlashMessage()

Creates a Message object and adds it to the FlashMessageQueue.


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

Parameters

$messageBody : string
$messageTitle : string = '': Optional message title
$severity : int|ContextualFeedbackSeverity = ContextualFeedbackSeverity::OK: Optional severity, must be one of \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity cases. Accepts int values as well, which is deprecated.
$storeInSession : bool = true: Optional, defines whether the message should be stored in the session (default) or not

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

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

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.

installExtensionWithoutSystemDependencyCheckAction()

Install an extension and omit dependency checking


    public
                    installExtensionWithoutSystemDependencyCheckAction(string $extensionKey) : ResponseInterface

Parameters

$extensionKey : string

Return values

ResponseInterface

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

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

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

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.

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

createZipFileFromExtension()

Create a zip file from an extension


    protected
                    createZipFileFromExtension(string $extensionKey) : string

Parameters

$extensionKey : string

Return values

string —

Name and path of create zip file

downloadExtensionZipAction()

Download an extension as a zip file


    protected
                    downloadExtensionZipAction(string $extension) : ResponseInterface

Parameters

$extension : string

Return values

ResponseInterface

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

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

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

handleTriggerArguments()

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


    protected
                    handleTriggerArguments(ModuleTemplate $view) : void

Parameters

$view : ModuleTemplate

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

initializeAction()

Initializes the controller before invoking an action method.


    protected
                    initializeAction() : mixed

Override this method to solve tasks which all actions have in common.

initializeActionMethodArguments()

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


    protected
                    initializeActionMethodArguments() : void

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() : void

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. Helper used in action that render backend moduleTemplate views and not just redirect or response download things.


    protected
                    initializeModuleTemplate(RequestInterface $request) : ModuleTemplate

Parameters

$request : RequestInterface

Return values

ModuleTemplate

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 ]) : ResponseInterface

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

ResponseInterface

redirectToUri()

Redirects the web request to another uri.


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

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

ResponseInterface

reloadExtensionDataAction()

Reloads the static SQL data of an extension


    protected
                    reloadExtensionDataAction(string $extension) : ResponseInterface

Parameters

$extension : string

Return values

ResponseInterface

removeExtensionAction()

Remove an extension (if it is still installed, uninstall it first)


    protected
                    removeExtensionAction(string $extension) : ResponseInterface

Parameters

$extension : string

Return values

ResponseInterface

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) : void

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()

Prepares a view for the current action.


    protected
                    resolveView() : ViewInterface

By default, this method tries to locate a view with a name matching the current action.

Internal

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

Return values

ViewInterface

setViewConfiguration()


    protected
                    setViewConfiguration(ViewInterface $view) : void

Parameters

$view : ViewInterface

Internal

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

toggleExtensionInstallationStateAction()

Toggle extension installation state action


    protected
                    toggleExtensionInstallationStateAction(string $extensionKey) : ResponseInterface

Parameters

$extensionKey : string

Return values

ResponseInterface

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

ActionController extends AbstractController

Table of Contents

Constants

Properties

Methods

Constants

TRIGGER_RefreshModuleMenu

TRIGGER_RefreshTopbar

Properties

$actionMethodName

$arguments

$configurationManager

$defaultViewObjectName

$errorMethodName

$eventDispatcher

$hashService

$installUtility read-only

$managementService read-only

$moduleTemplateFactory

$mvcPropertyMappingConfigurationService

$reflectionService

$registry read-only

$request

$responseFactory

$settings

$streamFactory

$triggerArguments

$uriBuilder

$validatorResolver

$view

Methods

__construct()

Parameters

addFlashMessage()

Parameters

Tags

initializeControllerArgumentsBaseValidators()

injectConfigurationManager()

Parameters

injectEventDispatcher()

Parameters

injectHashService()

Parameters

injectInternalExtensionService()

Parameters

injectInternalFlashMessageService()

Parameters

injectModuleTemplateFactory()

Parameters

injectMvcPropertyMappingConfigurationService()

Parameters

injectPropertyMapper()

Parameters

injectReflectionService()

Parameters

injectResponseFactory()

Parameters

injectStreamFactory()

Parameters

injectValidatorResolver()

Parameters

injectViewResolver()

Parameters

installExtensionWithoutSystemDependencyCheckAction()

Parameters

Return values

processRequest()

Parameters

Return values

throwStatus()

Parameters

Tags

Return values

addBaseUriIfNecessary()

Parameters

Return values

addErrorFlashMessage()

callActionMethod()

Parameters

Return values