‪TYPO3CMS  9.5
TYPO3\CMS\Form\Controller\FormManagerController Class Reference
Inheritance diagram for TYPO3\CMS\Form\Controller\FormManagerController:
TYPO3\CMS\Form\Controller\AbstractBackendController TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Extbase\Mvc\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 injectDatabaseService (\TYPO3\CMS\Form\Service\DatabaseService $databaseService)
 
 indexAction ()
 
 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)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Controller\AbstractBackendController
 injectFormPersistenceManager (\TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface $formPersistenceManager)
 
 initializeObject ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
 
 injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
 
ControllerContext getControllerContext ()
 
 __construct ()
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
 
bool canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 
 initializeControllerArgumentsBaseValidators ()
 

Protected Member Functions

array getAccessibleFormStorageFolders ()
 
string getFormManagerAppInitialData ()
 
array getAvailableFormDefinitions ()
 
array getProcessedReferencesRows (string $persistenceIdentifier)
 
bool isValidTemplatePath (string $prototypeName, string $templatePath)
 
 registerDocheaderButtons ()
 
string convertFormNameToIdentifier (string $formName)
 
array null getRecord (string $table, int $uid)
 
string getRecordTitle (string $table, array $row, bool $prep=false)
 
string getModuleUrl (string $moduleName, array $urlParameters=[])
 
BackendUserAuthentication getBackendUser ()
 
LanguageService getLanguageService ()
 
PageRenderer getPageRenderer ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Controller\AbstractBackendController
array resolveResourcePaths (array $resourcePaths)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 renderAssetsForRequest ($request)
 
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
string resolveActionMethodName ()
 
 callActionMethod ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
mixed resolveViewObjectName ()
 
 initializeView (ViewInterface $view)
 
 initializeAction ()
 
string errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
string getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase Mvc Controller ControllerContext buildControllerContext ()
 
 redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
 
 redirectToUri ($uri, $delay=0, $statusCode=303)
 
string addBaseUriIfNecessary ($uri)
 
 mapRequestArgumentsToControllerArguments ()
 

Protected Attributes

DatabaseService $databaseService
 
BackendTemplateView $defaultViewObjectName = BackendTemplateView::class
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Controller\AbstractBackendController
array $formSettings
 
TYPO3 CMS Form Mvc Persistence FormPersistenceManagerInterface $formPersistenceManager
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Service CacheService $cacheService
 
ViewInterface $view
 
string $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
array $viewFormatToObjectNameMap = array( )
 
string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
TYPO3 CMS Extbase Mvc Request $request
 
TYPO3 CMS Extbase Mvc Response $response
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder $uriBuilder
 
string $extensionName
 
array $settings
 
TYPO3 CMS Extbase Mvc RequestInterface $request
 
TYPO3 CMS Extbase Mvc ResponseInterface $response
 
TYPO3 CMS Extbase Validation ValidatorResolver $validatorResolver
 
TYPO3 CMS Extbase Mvc Controller Arguments $arguments
 
array $supportedRequestTypes = array( \TYPO3\CMS\Extbase\Mvc\Request::class )
 
TYPO3 CMS Extbase Mvc Controller ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static array getActionMethodParameters ($objectManager)
 

Detailed Description

The form manager controller

Scope: backend

Definition at line 43 of file FormManagerController.php.

Member Function Documentation

◆ convertFormNameToIdentifier()

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

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

Parameters
string$formName
Returns
‪string

Definition at line 526 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 
)

Creates a new Form and redirects to the Form Editor

Parameters
string$formName
string$templatePath
string$prototypeName
string$savePath
Exceptions
FormException
PersistenceManagerException

Definition at line 107 of file FormManagerController.php.

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

◆ deleteAction()

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

Delete a formDefinition identified by the $formPersistenceIdentifier.

Parameters
string$formPersistenceIdentifier‪persistence identifier to delete
Exceptions
PersistenceManagerException

Definition at line 270 of file FormManagerController.php.

References $GLOBALS, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\addFlashMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Form\Service\TranslationService\getInstance(), TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect(), and TYPO3\CMS\Form\Service\TranslationService\translateValuesRecursive().

◆ duplicateAction()

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

Duplicates a given formDefinition and redirects to the Form Editor

Parameters
string$formName
string$formPersistenceIdentifier‪persistence identifier of the form to duplicate
string$savePath
Exceptions
PersistenceManagerException

Definition at line 181 of file FormManagerController.php.

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

◆ getAccessibleFormStorageFolders()

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

Return a list of all accessible file mountpoints.

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

Returns
‪array

Definition at line 313 of file FormManagerController.php.

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

◆ getAvailableFormDefinitions()

array TYPO3\CMS\Form\Controller\FormManagerController::getAvailableFormDefinitions ( )
protected

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

Returns
‪array

Definition at line 372 of file FormManagerController.php.

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

◆ getBackendUser()

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

Returns the current BE user.

Returns
‪BackendUserAuthentication

Definition at line 580 of file FormManagerController.php.

References $GLOBALS.

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

◆ getFormManagerAppInitialData()

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

◆ getLanguageService()

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

Returns the Language Service

Returns
‪LanguageService

Definition at line 590 of file FormManagerController.php.

References $GLOBALS.

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

◆ getModuleUrl()

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

Wrapper used for unit testing.

Parameters
string$moduleName
array$urlParameters
Returns
‪string

Definition at line 568 of file FormManagerController.php.

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

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

◆ getPageRenderer()

PageRenderer TYPO3\CMS\Form\Controller\FormManagerController::getPageRenderer ( )
protected

Returns the page renderer

Returns
‪PageRenderer

Definition at line 600 of file FormManagerController.php.

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

◆ getProcessedReferencesRows()

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

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

Parameters
string$persistenceIdentifier
Returns
‪array
Exceptions

Definition at line 404 of file FormManagerController.php.

References TYPO3\CMS\Form\Controller\FormManagerController\getModuleUrl(), TYPO3\CMS\Form\Controller\FormManagerController\getRecord(), TYPO3\CMS\Form\Controller\FormManagerController\getRecordTitle(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ getRecord()

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

Wrapper used for unit testing.

Parameters
string$table
int$uid
Returns
‪array|null

Definition at line 543 of file FormManagerController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

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

◆ getRecordTitle()

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

Wrapper used for unit testing.

Parameters
string$table
array$row
bool$prep
Returns
‪string

Definition at line 556 of file FormManagerController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle().

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

◆ indexAction()

◆ initializeCreateAction()

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

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

Definition at line 91 of file FormManagerController.php.

◆ initializeDuplicateAction()

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

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

Definition at line 167 of file FormManagerController.php.

◆ initializeReferencesAction()

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

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

Definition at line 235 of file FormManagerController.php.

◆ injectDatabaseService()

TYPO3\CMS\Form\Controller\FormManagerController::injectDatabaseService ( \TYPO3\CMS\Form\Service\DatabaseService  $databaseService)
Parameters
\TYPO3\CMS\Form\Service\DatabaseService$databaseService

Definition at line 54 of file FormManagerController.php.

References TYPO3\CMS\Form\Controller\FormManagerController\$databaseService.

◆ isValidTemplatePath()

bool 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 TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.[('identifier': $prototypeName)].newFormTemplates.[('templatePath': $templatePath)]

Parameters
string$prototypeName
string$templatePath
Returns
‪bool

Definition at line 451 of file FormManagerController.php.

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

◆ referencesAction()

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

Show references to this persistence identifier

Parameters
string$formPersistenceIdentifier‪persistence identifier of the form to duplicate
Exceptions
PersistenceManagerException

Definition at line 247 of file FormManagerController.php.

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

◆ registerDocheaderButtons()

Member Data Documentation

◆ $databaseService

DatabaseService TYPO3\CMS\Form\Controller\FormManagerController::$databaseService
protected

◆ $defaultViewObjectName

BackendTemplateView TYPO3\CMS\Form\Controller\FormManagerController::$defaultViewObjectName = BackendTemplateView::class
protected

Default View Container

Definition at line 63 of file FormManagerController.php.