Inheritance diagram for TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager:

Public Member Functions
	__construct (YamlSource $yamlSource, StorageRepository $storageRepository, FilePersistenceSlot $filePersistenceSlot, ResourceFactory $resourceFactory, ConfigurationManagerInterface $configurationManager, CacheManager $cacheManager, EventDispatcherInterface $eventDispatcher,)

	load (string $persistenceIdentifier)

	save (string $persistenceIdentifier, array $formDefinition)

	delete (string $persistenceIdentifier)

bool	exists (string $persistenceIdentifier)

array	listForms ()

	hasForms ()

File[]	retrieveYamlFilesFromStorageFolders ()

string[]	retrieveYamlFilesFromExtensionFolders ()

Folder[]	getAccessibleFormStorageFolders ()

	getAccessibleExtensionFolders ()

string	getUniquePersistenceIdentifier (string $formIdentifier, string $savePath)

string	getUniqueIdentifier (string $identifier)

	checkForDuplicateIdentifier (string $identifier)

	isAllowedPersistencePath (string $persistencePath)

	hasValidFileExtension (string $fileName)

Public Attributes
const	FORM_DEFINITION_FILE_EXTENSION = '.form.yaml'

if(empty($this->typoScriptSettings['formDefinitionOverrides'][$formDefinition['identifier']] ?? null))	$formDefinitionOverrides

return	$formDefinition

Protected Member Functions
array< string, overrideFormDefinition(array $formDefinition, string $persistenceIdentifier, string $cacheKey):array { $formDefinition=$this-> eventDispatcher	dispatch (new AfterFormDefinitionLoadedEvent(formDefinition:$formDefinition, persistenceIdentifier:$persistenceIdentifier, cacheKey:$cacheKey)) -> getFormDefinition()

	pathIsIntendedAsExtensionPath (string $path)

	pathIsIntendedAsFileMountPath (string $path)

	getOrCreateFile (string $persistenceIdentifier)

	getStorageByUid (int $storageUid)

	loadMetaData ($persistenceIdentifier)

	extractMetaDataFromCouldBeFormDefinition (string $maybeRawFormDefinition)

	generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension (array $formDefinition, string $persistenceIdentifier)

	retrieveFileByPersistenceIdentifier (string $persistenceIdentifier)

	ensureValidPersistenceIdentifier (string $persistenceIdentifier)

	isFileWithinAccessibleExtensionFolders (string $fileName)

	isFileWithinAccessibleFormStorageFolders (string $fileName)

	isAccessibleExtensionFolder (string $folderName)

	isAccessibleFormStorageFolder (string $folderName)

	looksLikeAFormDefinition (array $data)

	sortForms (array $forms)

Protected Attributes
YamlSource	$yamlSource

StorageRepository	$storageRepository

FilePersistenceSlot	$filePersistenceSlot

ResourceFactory	$resourceFactory

array	$formSettings

array	$typoScriptSettings

FrontendInterface	$runtimeCache

EventDispatcherInterface	$eventDispatcher

Detailed Description

Concrete implementation of the FormPersistenceManagerInterface

Scope: frontend / backend

Definition at line 61 of file FormPersistenceManager.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::__construct	(	YamlSource	$yamlSource,
		StorageRepository	$storageRepository,
		FilePersistenceSlot	$filePersistenceSlot,
		ResourceFactory	$resourceFactory,
		ConfigurationManagerInterface	$configurationManager,
		CacheManager	$cacheManager,
		EventDispatcherInterface	$eventDispatcher
	)

Definition at line 74 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$eventDispatcher, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$filePersistenceSlot, $GLOBALS, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$resourceFactory, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$storageRepository, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$yamlSource, TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_SETTINGS, TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_YAML_SETTINGS, TYPO3\CMS\Core\Http\NormalizedParams\createFromRequest(), TYPO3\CMS\Core\Cache\CacheManager\getCache(), TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\getConfiguration(), TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\REQUESTTYPE_BE, and TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\setRequest().

Member Function Documentation

◆ checkForDuplicateIdentifier()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::checkForDuplicateIdentifier ( string $identifier )

Check if an identifier is already used by a formDefinition.

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 590 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$formDefinition, TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getUniqueIdentifier().

◆ delete()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::delete ( string $persistenceIdentifier )

Delete the form representation identified by $persistenceIdentifier. Only files with the extension .form.yaml are removed.

Exceptions

PersistenceManagerException

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 193 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\exists(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getStorageByUid(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasValidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleExtensionFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsExtensionPath().

◆ dispatch()

array<string, overrideFormDefinition(array $formDefinition, string $persistenceIdentifier, string $cacheKey): array { $formDefinition = $this-> eventDispatcher TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::dispatch ( new AfterFormDefinitionLoadedEventformDefinition:$formDefinition, persistenceIdentifier:$persistenceIdentifier, cacheKey:$cacheKey ) -> getFormDefinition()

protected

Allows to modify and override the formDefinition. Therefore, a PSR-14 Event is dispatched and if the TypoScript configuration path plugin.tx_form.settings.formDefinitionOverrides.<identifier> exists, these settings are merged into the formDefinition.

Parameters

array<string,mixed> ‪$formDefinition

Returns: ‪array<string, mixed>

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$formDefinition.

◆ ensureValidPersistenceIdentifier()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::ensureValidPersistenceIdentifier ( string $persistenceIdentifier )

protected

Exceptions

PersistenceManagerException
NoSuchFileException

Definition at line 876 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleExtensionFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsExtensionPath().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\load(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier().

◆ exists()

bool TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::exists ( string $persistenceIdentifier )

Check whether a form with the specified $persistenceIdentifier exists

Returns: ‪bool TRUE if a form with the given $persistenceIdentifier can be loaded, otherwise FALSE

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 228 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getStorageByUid(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasValidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleExtensionFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsExtensionPath().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\delete(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getUniquePersistenceIdentifier().

◆ extractMetaDataFromCouldBeFormDefinition()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::extractMetaDataFromCouldBeFormDefinition ( string $maybeRawFormDefinition )

protected

Definition at line 801 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData().

◆ generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension	(	array	$formDefinition,
		string	$persistenceIdentifier
	)

protected

Exceptions

PersistenceManagerException

Definition at line 836 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasValidFileExtension(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\looksLikeAFormDefinition().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\load(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData().

◆ getAccessibleExtensionFolders()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getAccessibleExtensionFolders ( )

Return a list of all accessible extension folders

Only registered mountpoints from persistenceManager.allowedExtensionPaths are listed.

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 486 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsExtensionPath().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAccessibleExtensionFolder(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleExtensionFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromExtensionFolders().

◆ getAccessibleFormStorageFolders()

Folder [] TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getAccessibleFormStorageFolders ( )

Return a list of all accessible file mountpoints for the current backend user.

Only registered mountpoints from persistenceManager.allowedFileMounts are listed.

Returns: ‪Folder[]

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 415 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getStorageByUid().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAccessibleFormStorageFolder(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleFormStorageFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromStorageFolders().

◆ getOrCreateFile()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getOrCreateFile ( string $persistenceIdentifier )

protected

Returns a File object for a given $persistenceIdentifier. If no file for this identifier exists a new object will be created.

Exceptions

PersistenceManagerException

Definition at line 710 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\COMMAND_FILE_CREATE, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getStorageByUid(), and TYPO3\CMS\Core\Utility\PathUtility\pathinfo().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ getStorageByUid()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getStorageByUid ( int $storageUid )

protected

Returns a ResourceStorage for a given uid

Exceptions

PersistenceManagerException

Definition at line 747 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\delete(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\exists(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleFormStorageFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getOrCreateFile().

◆ getUniqueIdentifier()

string TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getUniqueIdentifier ( string $identifier )

This takes a form identifier and returns a unique identifier for it. If a formDefinition with the same identifier already exists a suffix is appended until the identifier is unique.

Returns: ‪string unique form identifier

Exceptions

NoUniqueIdentifierException

Definition at line 564 of file FormPersistenceManager.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\checkForDuplicateIdentifier().

◆ getUniquePersistenceIdentifier()

string TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getUniquePersistenceIdentifier	(	string	$formIdentifier,
		string	$savePath
	)

This takes a form identifier and returns a unique persistence identifier for it. By default this is just similar to the identifier. But if a form with the same persistence identifier already exists a suffix is appended until the persistence identifier is unique.

Parameters

string $formIdentifier ‪lowerCamelCased form identifier

Returns: ‪string unique form persistence identifier

Exceptions

NoUniquePersistenceIdentifierException

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 531 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\exists(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\FORM_DEFINITION_FILE_EXTENSION.

◆ hasForms()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::hasForms ( )

Check if any form definition is available

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 329 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\looksLikeAFormDefinition(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromExtensionFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromStorageFolders().

◆ hasValidFileExtension()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::hasValidFileExtension ( string $fileName )

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

Definition at line 894 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\delete(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\exists(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ isAccessibleExtensionFolder()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::isAccessibleExtensionFolder ( string $folderName )

protected

Definition at line 921 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleExtensionFolders().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath().

◆ isAccessibleFormStorageFolder()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::isAccessibleFormStorageFolder ( string $folderName )

protected

Definition at line 927 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleFormStorageFolders().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath().

◆ isAllowedPersistencePath()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::isAllowedPersistencePath ( string $persistencePath )

Check if a persistence path or if a persistence identifier path is configured within the form setup (persistenceManager.allowedExtensionPaths / persistenceManager.allowedFileMounts). If the input is a persistence identifier an additional check for a valid file extension will be performed.

Definition at line 611 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasValidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAccessibleExtensionFolder(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAccessibleFormStorageFolder(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleExtensionFolders(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleFormStorageFolders(), TYPO3\CMS\Core\Utility\PathUtility\pathinfo(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsExtensionPath(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsFileMountPath().

◆ isFileWithinAccessibleExtensionFolders()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::isFileWithinAccessibleExtensionFolders ( string $fileName )

protected

Definition at line 899 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleExtensionFolders(), and TYPO3\CMS\Core\Utility\PathUtility\pathinfo().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\delete(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\ensureValidPersistenceIdentifier(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\exists(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ isFileWithinAccessibleFormStorageFolders()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::isFileWithinAccessibleFormStorageFolders ( string $fileName )

protected

Definition at line 907 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleFormStorageFolders(), and TYPO3\CMS\Core\Utility\PathUtility\pathinfo().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath().

◆ listForms()

array TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::listForms ( )

List all form definitions which can be loaded through this form persistence manager.

Returns an associative array with each item containing the keys 'name' (the human-readable name of the form) and 'persistenceIdentifier' (the unique identifier for the Form Persistence Manager e.g. the path to the saved form definition).

Returns: ‪array in the format [['name' => 'Form 01', 'persistenceIdentifier' => 'path1'], [ .... ]]

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 255 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$formDefinition, TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasValidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\looksLikeAFormDefinition(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromExtensionFolders(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromStorageFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\sortForms().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\checkForDuplicateIdentifier().

◆ load()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::load ( string $persistenceIdentifier )

Load the array formDefinition identified by $persistenceIdentifier, let event listeners modify it, override it by TypoScript settings, and return it. Only files with the extension .yaml or .form.yaml are loaded.

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 113 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\ensureValidPersistenceIdentifier(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension(), TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier().

◆ loadMetaData()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::loadMetaData ( $persistenceIdentifier )

protected

Parameters

string | File $persistenceIdentifier

Exceptions

NoSuchFileException

Definition at line 760 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\ensureValidPersistenceIdentifier(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\extractMetaDataFromCouldBeFormDefinition(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension(), TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasForms(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms().

◆ looksLikeAFormDefinition()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::looksLikeAFormDefinition ( array $data )

protected

Definition at line 933 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasForms(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms().

◆ pathIsIntendedAsExtensionPath()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::pathIsIntendedAsExtensionPath ( string $path )

protected

Definition at line 684 of file FormPersistenceManager.php.

References TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\delete(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\ensureValidPersistenceIdentifier(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\exists(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleExtensionFolders(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ pathIsIntendedAsFileMountPath()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::pathIsIntendedAsFileMountPath ( string $path )

protected

Definition at line 689 of file FormPersistenceManager.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath().

◆ retrieveFileByPersistenceIdentifier()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::retrieveFileByPersistenceIdentifier ( string $persistenceIdentifier )

protected

Exceptions

PersistenceManagerException
NoSuchFileException

Definition at line 850 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\ensureValidPersistenceIdentifier().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\load(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData().

◆ retrieveYamlFilesFromExtensionFolders()

string [] TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::retrieveYamlFilesFromExtensionFolders ( )

Retrieves yaml files from extension folders for further processing. At this time it's not determined yet, whether these files contain form data.

Returns: ‪string[]

Definition at line 388 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleExtensionFolders().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasForms(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms().

◆ retrieveYamlFilesFromStorageFolders()

File [] TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::retrieveYamlFilesFromStorageFolders ( )

Retrieves yaml files from storage folders for further processing. At this time it's not determined yet, whether these files contain form data.

Returns: ‪File[]

Definition at line 355 of file FormPersistenceManager.php.

References TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getAccessibleFormStorageFolders().

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasForms(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms().

◆ save()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::save	(	string	$persistenceIdentifier,
		array	$formDefinition
	)

Save the array form representation identified by $persistenceIdentifier. Only files with the extension .form.yaml are saved. If the formDefinition is located within an EXT: resource, save is only allowed if the configuration path persistenceManager.allowSaveToExtensionPaths is set to true.

Exceptions

PersistenceManagerException

Implements TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface.

Definition at line 156 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\$formDefinition, TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getOrCreateFile(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\hasValidFileExtension(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isFileWithinAccessibleExtensionFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\pathIsIntendedAsExtensionPath().

◆ sortForms()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::sortForms ( array $forms )

protected

Definition at line 938 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms().

Member Data Documentation

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$eventDispatcher

protected

Definition at line 72 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\__construct().

◆ $filePersistenceSlot

FilePersistenceSlot TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$filePersistenceSlot

protected

Definition at line 67 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\__construct().

◆ $formDefinition

return TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$formDefinition

Definition at line 681 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\checkForDuplicateIdentifier(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\dispatch(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\listForms(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ $formDefinitionOverrides

if (empty( $this->typoScriptSettings[ 'formDefinitionOverrides'][ $formDefinition[ 'identifier']] ?? null)) TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$formDefinitionOverrides

Initial value:

= GeneralUtility::makeInstance(TypoScriptService::class)

->resolvePossibleTypoScriptConfiguration($this->typoScriptSettings['formDefinitionOverrides'][‪$formDefinition['identifier']])

Definition at line 673 of file FormPersistenceManager.php.

◆ $formSettings

array TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$formSettings

protected

Definition at line 69 of file FormPersistenceManager.php.

◆ $resourceFactory

ResourceFactory TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$resourceFactory

protected

Definition at line 68 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\__construct().

◆ $runtimeCache

FrontendInterface TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$runtimeCache

protected

Definition at line 71 of file FormPersistenceManager.php.

◆ $storageRepository

StorageRepository TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$storageRepository

protected

Definition at line 66 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\__construct().

◆ $typoScriptSettings

array TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$typoScriptSettings

protected

Definition at line 70 of file FormPersistenceManager.php.

◆ $yamlSource

YamlSource TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::$yamlSource

protected

Definition at line 65 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\__construct().

◆ FORM_DEFINITION_FILE_EXTENSION

const TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::FORM_DEFINITION_FILE_EXTENSION = '.form.yaml'

Definition at line 63 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\EventListener\ProcessFileListActionsEventListener\__invoke(), TYPO3\CMS\Form\Hooks\FormFileProvider\canHandle(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getUniquePersistenceIdentifier(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\isFormDefinition().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkForDuplicateIdentifier()

◆ delete()

◆ dispatch()

◆ ensureValidPersistenceIdentifier()

◆ exists()

◆ extractMetaDataFromCouldBeFormDefinition()

◆ generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension()

◆ getAccessibleExtensionFolders()

◆ getAccessibleFormStorageFolders()

◆ getOrCreateFile()

◆ getStorageByUid()

◆ getUniqueIdentifier()

◆ getUniquePersistenceIdentifier()

◆ hasForms()

◆ hasValidFileExtension()

◆ isAccessibleExtensionFolder()

◆ isAccessibleFormStorageFolder()

◆ isAllowedPersistencePath()

◆ isFileWithinAccessibleExtensionFolders()

◆ isFileWithinAccessibleFormStorageFolders()

◆ listForms()

◆ load()

◆ loadMetaData()

◆ looksLikeAFormDefinition()

◆ pathIsIntendedAsExtensionPath()

◆ pathIsIntendedAsFileMountPath()

◆ retrieveFileByPersistenceIdentifier()

◆ retrieveYamlFilesFromExtensionFolders()

◆ retrieveYamlFilesFromStorageFolders()

◆ save()

◆ sortForms()

Member Data Documentation

◆ $eventDispatcher

◆ $filePersistenceSlot

◆ $formDefinition

◆ $formDefinitionOverrides

◆ $formSettings

◆ $resourceFactory

◆ $runtimeCache

◆ $storageRepository

◆ $typoScriptSettings

◆ $yamlSource

◆ FORM_DEFINITION_FILE_EXTENSION