Inheritance diagram for TYPO3\CMS\Form\Controller\FormManagerController:

Public Member Functions
	__construct (protected readonly ModuleTemplateFactory $moduleTemplateFactory, protected readonly PageRenderer $pageRenderer, protected readonly IconFactory $iconFactory, protected DatabaseService $databaseService,)

‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Controller\AbstractBackendController
	injectFormPersistenceManager (FormPersistenceManagerInterface $formPersistenceManager)

	initializeObject ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	injectResponseFactory (ResponseFactoryInterface $responseFactory)

	injectStreamFactory (StreamFactoryInterface $streamFactory)

	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)

	injectValidatorResolver (ValidatorResolver $validatorResolver)

	injectViewResolver (ViewResolverInterface $viewResolver)

	injectReflectionService (ReflectionService $reflectionService)

	injectHashService (HashService $hashService)

	injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)

	injectEventDispatcher (EventDispatcherInterface $eventDispatcher)

	injectPropertyMapper (PropertyMapper $propertyMapper)

	injectInternalFlashMessageService (FlashMessageService $flashMessageService)

	injectInternalExtensionService (ExtensionService $extensionService)

	initializeControllerArgumentsBaseValidators ()

	processRequest (RequestInterface $request)

	addFlashMessage (string $messageBody, string $messageTitle='', ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK, bool $storeInSession=true)

	throwStatus (int $statusCode, string $statusMessage='', ?string $content=null)

Protected Member Functions
	indexAction (int $page=1, string $searchTerm='')

	initializeCreateAction ()

	createAction (string $formName, string $templatePath, string $prototypeName, string $savePath)

	initializeDuplicateAction ()

	duplicateAction (string $formName, string $formPersistenceIdentifier, string $savePath)

	initializeReferencesAction ()

	referencesAction (string $formPersistenceIdentifier)

	deleteAction (string $formPersistenceIdentifier)

	getAccessibleFormStorageFolders ()

	getFormManagerAppInitialData ()

	getAvailableFormDefinitions (string $searchTerm='')

	valueContainsSearchTerm (string $value, string $searchTerm)

	getProcessedReferencesRows (string $persistenceIdentifier)

	isValidTemplatePath (string $prototypeName, string $templatePath)

	initializeModuleTemplate (ServerRequestInterface $request, int $page, string $searchTerm)

	convertFormNameToIdentifier (string $formName)

	getRecord (string $table, int $uid)

	getRecordTitle (string $table, array $row, bool $prep=false)

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

	getBackendUser ()

	getLanguageService ()

‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeAction ()

	initializeActionMethodArguments ()

	initializeActionMethodValidators ()

	renderAssetsForRequest (RequestInterface $request)

	resolveActionMethodName ()

	callActionMethod (RequestInterface $request)

	resolveView ()

	setViewConfiguration (ViewInterface $view)

	errorAction ()

	addErrorFlashMessage ()

	getErrorFlashMessage ()

	forwardToReferringRequest ()

	getFlattenedValidationErrorMessage ()

	getFlashMessageQueue (string $identifier=null)

	redirect (?string $actionName, ?string $controllerName=null, ?string $extensionName=null, ?array $arguments=null, ?int $pageUid=null, $_=null, int $statusCode=303)

	redirectToUri (string\|UriInterface $uri, $_=null, int $statusCode=303)

	addBaseUriIfNecessary (string $uri)

	mapRequestArgumentsToControllerArguments ()

	htmlResponse (string $html=null)

	jsonResponse (string $json=null)

Protected Attributes
const	JS_MODULE_NAMES = ['app', 'viewModel']

int	$limit = 20

‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Controller\AbstractBackendController
array	$formSettings

FormPersistenceManagerInterface	$formPersistenceManager

‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
ResponseFactoryInterface	$responseFactory

StreamFactoryInterface	$streamFactory

HashService	$hashService

ReflectionService	$reflectionService

ViewInterface	$view

string	$defaultViewObjectName = TemplateView::class

string	$actionMethodName = 'indexAction'

string	$errorMethodName = 'errorAction'

MvcPropertyMappingConfigurationService	$mvcPropertyMappingConfigurationService

EventDispatcherInterface	$eventDispatcher

RequestInterface	$request

UriBuilder	$uriBuilder

array	$settings

ValidatorResolver	$validatorResolver

Arguments	$arguments

ConfigurationManagerInterface	$configurationManager

Detailed Description

The form manager controller

Scope: backend

Definition at line 52 of file FormManagerController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Form\Controller\FormManagerController::__construct	(	protected readonly ModuleTemplateFactory	$moduleTemplateFactory,
		protected readonly PageRenderer	$pageRenderer,
		protected readonly IconFactory	$iconFactory,
		protected DatabaseService	$databaseService
	)

Definition at line 58 of file FormManagerController.php.

Member Function Documentation

◆ convertFormNameToIdentifier()

TYPO3\CMS\Form\Controller\FormManagerController::convertFormNameToIdentifier ( string $formName )

protected

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

Definition at line 528 of file FormManagerController.php.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\createAction(), and TYPO3\CMS\Form\Controller\FormManagerController\duplicateAction().

◆ createAction()

TYPO3\CMS\Form\Controller\FormManagerController::createAction	(	string	$formName,
		string	$templatePath,
		string	$prototypeName,
		string	$savePath
	)

protected

Creates a new Form and redirects to the Form Editor

Exceptions

FormException
PersistenceManagerException

Definition at line 125 of file FormManagerController.php.

References $GLOBALS, TYPO3\CMS\Form\Controller\FormManagerController\convertFormNameToIdentifier(), TYPO3\CMS\Form\Controller\FormManagerController\isValidTemplatePath(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\jsonResponse().

◆ deleteAction()

TYPO3\CMS\Form\Controller\FormManagerController::deleteAction ( string $formPersistenceIdentifier )

protected

Delete a formDefinition identified by the $formPersistenceIdentifier.

Exceptions

PersistenceManagerException

Definition at line 282 of file FormManagerController.php.

References $GLOBALS, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\addFlashMessage(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\redirect().

◆ duplicateAction()

TYPO3\CMS\Form\Controller\FormManagerController::duplicateAction	(	string	$formName,
		string	$formPersistenceIdentifier,
		string	$savePath
	)

protected

Duplicates a given formDefinition and redirects to the Form Editor

Exceptions

PersistenceManagerException

Definition at line 195 of file FormManagerController.php.

References $GLOBALS, TYPO3\CMS\Form\Controller\FormManagerController\convertFormNameToIdentifier(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\jsonResponse().

◆ getAccessibleFormStorageFolders()

TYPO3\CMS\Form\Controller\FormManagerController::getAccessibleFormStorageFolders ( )

protected

Return a list of all accessible file mountpoints.

Only registered mount points from persistenceManager.allowedFileMounts are listed. This list will be reduced by the configured mount points for the current backend user.

Definition at line 323 of file FormManagerController.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\getFormManagerAppInitialData().

◆ getAvailableFormDefinitions()

TYPO3\CMS\Form\Controller\FormManagerController::getAvailableFormDefinitions ( string $searchTerm = '' )

protected

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

Definition at line 374 of file FormManagerController.php.

References TYPO3\CMS\Form\Controller\FormManagerController\valueContainsSearchTerm().

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\indexAction().

◆ getBackendUser()

TYPO3\CMS\Form\Controller\FormManagerController::getBackendUser ( )

protected

Definition at line 564 of file FormManagerController.php.

References $GLOBALS.

◆ getFormManagerAppInitialData()

TYPO3\CMS\Form\Controller\FormManagerController::getFormManagerAppInitialData ( )

protected

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

Definition at line 349 of file FormManagerController.php.

References TYPO3\CMS\Form\Controller\FormManagerController\getAccessibleFormStorageFolders(), and TYPO3\CMS\Core\Utility\ArrayUtility\reIndexNumericArrayKeysRecursive().

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\indexAction().

◆ getLanguageService()

TYPO3\CMS\Form\Controller\FormManagerController::getLanguageService ( )

protected

Definition at line 569 of file FormManagerController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\indexAction(), and TYPO3\CMS\Form\Controller\FormManagerController\initializeModuleTemplate().

◆ getModuleUrl()

TYPO3\CMS\Form\Controller\FormManagerController::getModuleUrl	(	string	$moduleName,
		array	$urlParameters = `[]`
	)

protected

Wrapper used for unit testing.

Definition at line 558 of file FormManagerController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$uriBuilder.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\getProcessedReferencesRows().

◆ getProcessedReferencesRows()

TYPO3\CMS\Form\Controller\FormManagerController::getProcessedReferencesRows ( string $persistenceIdentifier )

protected

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

Exceptions

Definition at line 414 of file FormManagerController.php.

References TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Form\Controller\FormManagerController\getModuleUrl(), TYPO3\CMS\Form\Controller\FormManagerController\getRecord(), and TYPO3\CMS\Form\Controller\FormManagerController\getRecordTitle().

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\referencesAction().

◆ getRecord()

TYPO3\CMS\Form\Controller\FormManagerController::getRecord	(	string	$table,
		int	$uid
	)

protected

Wrapper used for unit testing.

Definition at line 542 of file FormManagerController.php.

References TYPO3\CMS\Webhooks\Message\$uid.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\getProcessedReferencesRows().

◆ getRecordTitle()

TYPO3\CMS\Form\Controller\FormManagerController::getRecordTitle	(	string	$table,
		array	$row,
		bool	$prep = `false`
	)

protected

Wrapper used for unit testing.

Definition at line 550 of file FormManagerController.php.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\getProcessedReferencesRows().

◆ indexAction()

TYPO3\CMS\Form\Controller\FormManagerController::indexAction	(	int	$page = `1`,
		string	$searchTerm = `''`
	)

protected

Display the Form Manager. The main showing available forms.

Definition at line 69 of file FormManagerController.php.

References TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\create(), TYPO3\CMS\Form\Controller\FormManagerController\getAvailableFormDefinitions(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\getFlashMessageQueue(), TYPO3\CMS\Form\Controller\FormManagerController\getFormManagerAppInitialData(), TYPO3\CMS\Form\Controller\FormManagerController\getLanguageService(), and TYPO3\CMS\Form\Controller\FormManagerController\initializeModuleTemplate().

◆ initializeCreateAction()

TYPO3\CMS\Form\Controller\FormManagerController::initializeCreateAction ( )

protected

Initialize the "create" action. This action uses the Fluid JsonView::class as view.

Definition at line 114 of file FormManagerController.php.

◆ initializeDuplicateAction()

TYPO3\CMS\Form\Controller\FormManagerController::initializeDuplicateAction ( )

protected

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

Definition at line 185 of file FormManagerController.php.

◆ initializeModuleTemplate()

TYPO3\CMS\Form\Controller\FormManagerController::initializeModuleTemplate	(	ServerRequestInterface	$request,
		int	$page,
		string	$searchTerm
	)

protected

Init ModuleTemplate and register document header buttons

Definition at line 484 of file FormManagerController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$arguments, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$request, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Template\ModuleTemplate\getDocHeaderComponent(), and TYPO3\CMS\Form\Controller\FormManagerController\getLanguageService().

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\indexAction().

◆ initializeReferencesAction()

TYPO3\CMS\Form\Controller\FormManagerController::initializeReferencesAction ( )

protected

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

Definition at line 249 of file FormManagerController.php.

◆ isValidTemplatePath()

TYPO3\CMS\Form\Controller\FormManagerController::isValidTemplatePath	(	string	$prototypeName,
		string	$templatePath
	)

protected

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

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

Definition at line 457 of file FormManagerController.php.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\createAction().

◆ referencesAction()

TYPO3\CMS\Form\Controller\FormManagerController::referencesAction ( string $formPersistenceIdentifier )

protected

Show references to this persistence identifier

Exceptions

PersistenceManagerException

Definition at line 259 of file FormManagerController.php.

References TYPO3\CMS\Form\Controller\FormManagerController\getProcessedReferencesRows(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\jsonResponse().

◆ valueContainsSearchTerm()

TYPO3\CMS\Form\Controller\FormManagerController::valueContainsSearchTerm	(	string	$value,
		string	$searchTerm
	)

protected

Definition at line 403 of file FormManagerController.php.

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\getAvailableFormDefinitions().

Member Data Documentation

◆ $limit

int TYPO3\CMS\Form\Controller\FormManagerController::$limit = 20

protected

Definition at line 56 of file FormManagerController.php.

◆ JS_MODULE_NAMES

const TYPO3\CMS\Form\Controller\FormManagerController::JS_MODULE_NAMES = ['app', 'viewModel']

protected

Definition at line 54 of file FormManagerController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertFormNameToIdentifier()

◆ createAction()

◆ deleteAction()

◆ duplicateAction()

◆ getAccessibleFormStorageFolders()

◆ getAvailableFormDefinitions()

◆ getBackendUser()

◆ getFormManagerAppInitialData()

◆ getLanguageService()

◆ getModuleUrl()

◆ getProcessedReferencesRows()

◆ getRecord()

◆ getRecordTitle()

◆ indexAction()

◆ initializeCreateAction()

◆ initializeDuplicateAction()

◆ initializeModuleTemplate()

◆ initializeReferencesAction()

◆ isValidTemplatePath()

◆ referencesAction()

◆ valueContainsSearchTerm()

Member Data Documentation

◆ $limit

◆ JS_MODULE_NAMES