FormManagerController

class \TYPO3\CMS\Form\Controller\FormManagerController

Extends
AbstractBackendController

The form manager controller

Scope: backend

Table of Contents

Constants

JS_MODULE_NAMES  : mixed = ['app', 'viewModel']

Properties

$actionMethodName  : string
Name of the action method
$arguments  : Arguments
$configurationManager  : ConfigurationManagerInterface
$controllerContext  : ControllerContext
$databaseService  : DatabaseService
$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
$formPersistenceManager  : FormPersistenceManagerInterface
$formSettings  : array
$hashService  : HashService
$iconFactory  : IconFactory
$limit  : int
$moduleTemplateFactory  : ModuleTemplateFactory
$mvcPropertyMappingConfigurationService  : MvcPropertyMappingConfigurationService
$objectManager  : ObjectManagerInterface
$pageRenderer  : PageRenderer
$reflectionService  : ReflectionService
$request  : Request
The current request.
$responseFactory  : ResponseFactoryInterface
$settings  : array
Contains the settings of the current extension
$signalSlotDispatcher  : Dispatcher
$streamFactory  : StreamFactoryInterface
$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.
createAction()  : ResponseInterface
Creates a new Form and redirects to the Form Editor
deleteAction()  : mixed
Delete a formDefinition identified by the $formPersistenceIdentifier.
duplicateAction()  : ResponseInterface
Duplicates a given formDefinition and redirects to the Form Editor
forward()  : never
Forwards the request to another action and / or controller.
getControllerContext()  : ControllerContext
indexAction()  : ResponseInterface
Displays the Form Manager
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.
initializeCreateAction()  : mixed
Initialize the create action.
initializeDuplicateAction()  : mixed
Initialize the duplicate action.
initializeObject()  : mixed
initializeReferencesAction()  : mixed
Initialize the references action.
injectConfigurationManager()  : mixed
injectEventDispatcher()  : void
injectFormPersistenceManager()  : mixed
injectHashService()  : mixed
injectInternalExtensionService()  : void
injectInternalFlashMessageService()  : void
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
referencesAction()  : ResponseInterface
Show references to this persistence identifier
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.
buildControllerContext()  : ControllerContext
Initialize the controller context
callActionMethod()  : ResponseInterface
Calls the specified action method and passes the arguments.
convertFormNameToIdentifier()  : string
Returns a form identifier which is the lower cased form name.
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!
getAccessibleFormStorageFolders()  : array
Return a list of all accessible file mountpoints.
getAvailableFormDefinitions()  : array
List all formDefinitions which can be loaded through t form persistence manager. Enrich this data by a reference counter.
getBackendUser()  : BackendUserAuthentication
Returns the current BE user.
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.
getFormManagerAppInitialData()  : array
Returns the json encoded data which is used by the form editor JavaScript app.
getLanguageService()  : LanguageService
Returns the Language Service
getModuleUrl()  : string
Wrapper used for unit testing.
getProcessedReferencesRows()  : array
Returns an array with information about the references for a formDefinition identified by $persistenceIdentifier.
getRecord()  : array|null
Wrapper used for unit testing.
getRecordTitle()  : string
Wrapper used for unit testing.
getViewProperty()  : array
Handles the path resolving for *rootPath(s)
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()  : 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
Init ModuleTemplate and register document header buttons
initializeView()  : mixed
Initializes the view before invoking an action method.
isValidTemplatePath()  : bool
Check if a given $templatePath for a given $prototypeName is valid and accessible.
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.
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
resolveResourcePaths()  : array
The functionality of this method has been removed because it caused problems with open_basedir restrictions.
resolveView()  : ViewInterface
Prepares a view for the current action.
setViewConfiguration()  : mixed

Constants

JS_MODULE_NAMES

protected mixed JS_MODULE_NAMES = ['app', 'viewModel']

Properties

$actionMethodName

Name of the action method

protected string $actionMethodName = 'indexAction'

$controllerContext

Deprecated

since v11, will be removed with v12.

protected ControllerContext $controllerContext

$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

$formSettings

protected array $formSettings

$hashService

protected HashService $hashService

$objectManager

Deprecated

since v11, will be removed in v12

protected ObjectManagerInterface $objectManager

$reflectionService

protected ReflectionService $reflectionService

$request

The current request.

protected Request $request

Tags

todo

v12: Change @var to RequestInterface, when RequestInterface extends ServerRequestInterface

$responseFactory

protected ResponseFactoryInterface $responseFactory

$settings

Contains the settings of the current extension

protected array $settings

$signalSlotDispatcher

protected Dispatcher $signalSlotDispatcher

$streamFactory

protected StreamFactoryInterface $streamFactory

$validatorResolver

protected ValidatorResolver $validatorResolver

$view

The current view, as resolved by resolveView()

protected ViewInterface $view

Tags

todo

v12: Change signature to TYPO3Fluid\Fluid\View\ViewInterface when extbase ViewInterface is dropped.

Methods

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

Tags

throws
InvalidArgumentException

if the message body is no string

see
FlashMessage

createAction()

Creates a new Form and redirects to the Form Editor

public createAction(string $formName, string $templatePath, string $prototypeName, string $savePath) : ResponseInterface

Parameters

$formName : string
$templatePath : string
$prototypeName : string
$savePath : string

Tags

throws
Exception
throws
PersistenceManagerException

Return values

ResponseInterface

deleteAction()

Delete a formDefinition identified by the $formPersistenceIdentifier.

public deleteAction(string $formPersistenceIdentifier) : mixed

Parameters

$formPersistenceIdentifier : string

persistence identifier to delete

Tags

throws
PersistenceManagerException

duplicateAction()

Duplicates a given formDefinition and redirects to the Form Editor

public duplicateAction(string $formName, string $formPersistenceIdentifier, string $savePath) : ResponseInterface

Parameters

$formName : string
$formPersistenceIdentifier : string

persistence identifier of the form to duplicate

$savePath : string

Tags

throws
PersistenceManagerException

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|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|null = null

Arguments to pass to the target action

Tags

throws
StopActionException
see
redirect()

Return values

never

indexAction()

Displays the Form Manager

public indexAction([int $page = 1 ]) : ResponseInterface

Parameters

$page : int = 1

Return values

ResponseInterface

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

initializeCreateAction()

Initialize the create action.

public initializeCreateAction() : mixed

This action uses the Fluid JsonView::class as view.

initializeDuplicateAction()

Initialize the duplicate action.

public initializeDuplicateAction() : mixed

This action uses the Fluid JsonView::class as view.

initializeObject()

public initializeObject() : mixed

initializeReferencesAction()

Initialize the references action.

public initializeReferencesAction() : mixed

This action uses the Fluid JsonView::class as view.

injectEventDispatcher()

public injectEventDispatcher(EventDispatcherInterface $eventDispatcher) : void

Parameters

$eventDispatcher : EventDispatcherInterface

injectHashService()

public injectHashService(HashService $hashService) : mixed

Parameters

$hashService : HashService

injectInternalExtensionService()

public final injectInternalExtensionService(ExtensionService $extensionService) : void

Parameters

$extensionService : ExtensionService

injectInternalFlashMessageService()

public final injectInternalFlashMessageService(FlashMessageService $flashMessageService) : void

Parameters

$flashMessageService : FlashMessageService

injectObjectManager()

Injects the object manager

public injectObjectManager(ObjectManagerInterface $objectManager) : mixed

Deprecated

since v11, will be removed in v12

Parameters

$objectManager : ObjectManagerInterface

injectPropertyMapper()

public injectPropertyMapper(PropertyMapper $propertyMapper) : void

Parameters

$propertyMapper : PropertyMapper

injectReflectionService()

public injectReflectionService(ReflectionService $reflectionService) : mixed

Parameters

$reflectionService : ReflectionService

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

injectStreamFactory()

public final injectStreamFactory(StreamFactoryInterface $streamFactory) : mixed

Parameters

$streamFactory : StreamFactoryInterface

injectValidatorResolver()

public injectValidatorResolver(ValidatorResolver $validatorResolver) : mixed

Parameters

$validatorResolver : ValidatorResolver

processRequest()

Handles an incoming request and returns a response object

public processRequest(RequestInterface $request) : ResponseInterface

Parameters

$request : RequestInterface

The request object

Return values

ResponseInterface

referencesAction()

Show references to this persistence identifier

public referencesAction(string $formPersistenceIdentifier) : ResponseInterface

Parameters

$formPersistenceIdentifier : string

persistence identifier of the form to duplicate

Tags

throws
PersistenceManagerException

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

Tags

throws
PropagateResponseException

Return values

never

addBaseUriIfNecessary()

Adds the base uri if not already in place.

protected addBaseUriIfNecessary(string $uri) : string

Parameters

$uri : string

The URI

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

buildControllerContext()

Initialize the controller context

protected buildControllerContext() : ControllerContext

Deprecated

since v11, will be removed with v12.

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

Return values

ResponseInterface

convertFormNameToIdentifier()

Returns a form identifier which is the lower cased form name.

protected convertFormNameToIdentifier(string $formName) : string

Parameters

$formName : string

Return values

string

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

Return values

ResponseInterface|null

getAccessibleFormStorageFolders()

Return a list of all accessible file mountpoints.

protected getAccessibleFormStorageFolders() : array

Only registered mountpoints from TYPO3.CMS.Form.persistenceManager.allowedFileMounts are listed. This list will be reduced by the configured mountpoints for the current backend user.

Return values

array

getAvailableFormDefinitions()

List all formDefinitions which can be loaded through t form persistence manager. Enrich this data by a reference counter.

protected getAvailableFormDefinitions() : array

Return values

array

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

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

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.

Return values

string

getFormManagerAppInitialData()

Returns the json encoded data which is used by the form editor JavaScript app.

protected getFormManagerAppInitialData() : array

Return values

array

getModuleUrl()

Wrapper used for unit testing.

protected getModuleUrl(string $moduleName[, array $urlParameters = [] ]) : string

Parameters

$moduleName : string
$urlParameters : array = []

Return values

string

getProcessedReferencesRows()

Returns an array with information about the references for a formDefinition identified by $persistenceIdentifier.

protected getProcessedReferencesRows(string $persistenceIdentifier) : array

Parameters

$persistenceIdentifier : string

Tags

throws
InvalidArgumentException

Return values

array

getRecord()

Wrapper used for unit testing.

protected getRecord(string $table, int $uid) : array|null

Parameters

$table : string
$uid : int

Return values

array|null

getRecordTitle()

Wrapper used for unit testing.

protected getRecordTitle(string $table, array $row[, bool $prep = false ]) : string

Parameters

$table : string
$row : array
$prep : bool = false

Return values

string

getViewProperty()

Handles the path resolving for *rootPath(s)

protected getViewProperty(array $extbaseFrameworkConfiguration, string $setting) : array

numerical arrays get ordered by key ascending

Parameters

$extbaseFrameworkConfiguration : array
$setting : string

parameter name from TypoScript

Return values

array

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

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

Tags

throws
InvalidArgumentTypeException
see
initializeArguments()

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

initializeModuleTemplate()

Init ModuleTemplate and register document header buttons

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

isValidTemplatePath()

Check if a given $templatePath for a given $prototypeName is valid and accessible.

protected isValidTemplatePath(string $prototypeName, string $templatePath) : bool

Valid template paths has to be configured within TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.[('identifier': $prototypeName)].newFormTemplates.[('templatePath': $templatePath)]

Parameters

$prototypeName : string
$templatePath : string

Return values

bool

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

Tags

throws
RequiredArgumentMissingException

redirect()

Redirects the request to another action and / or controller.

protected redirect(string|null $actionName[, string|null $controllerName = null ][, string|null $extensionName = null ][, array|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|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

Tags

throws
StopActionException

deprecated since TYPO3 11.0, method will RETURN a Core\Http\RedirectResponse instead of throwing in v12

todo:

': ResponseInterface' (without ?) in v12 as method return type together with redirectToUri() cleanup

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"

Tags

throws
StopActionException

deprecated since TYPO3 11.0, will be removed in 12.0

todo:

': ResponseInterface' (without ?) in v12 as method return type together with redirectToUri() cleanup

Return values

never

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

resolveActionMethodName()

Resolves and checks the current action method name

protected resolveActionMethodName() : string

Tags

throws
NoSuchActionException

if the action specified in the request object does not exist (and if there's no default action either).

Return values

string —

Method name of the current action

resolveResourcePaths()

The functionality of this method has been removed because it caused problems with open_basedir restrictions.

protected resolveResourcePaths(array $resourcePaths) : array

See https://forge.typo3.org/issues/98545 for details. This method will be removed in TYPO3 v13.

Parameters

$resourcePaths : array

Return values

array

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.

Tags

todo

v12: Change signature to TYPO3Fluid\Fluid\View\ViewInterface when extbase ViewInterface is dropped.

Return values

ViewInterface

setViewConfiguration()

protected setViewConfiguration(ViewInterface $view) : mixed

Parameters

$view : ViewInterface

Tags

todo

v12: Change signature to TYPO3Fluid\Fluid\View\ViewInterface when extbase ViewInterface is dropped.

On this page