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

Public Member Functions
	injectYamlSource (YamlSource $yamlSource)

	injectStorageRepository (StorageRepository $storageRepository)

	injectFilePersistenceSlot (FilePersistenceSlot $filePersistenceSlot)

	injectResourceFactory (ResourceFactory $resourceFactory)

	initializeObject ()

array	load (string $persistenceIdentifier)

	save (string $persistenceIdentifier, array $formDefinition)

	delete (string $persistenceIdentifier)

bool	exists (string $persistenceIdentifier)

array	listForms ()

File[]	retrieveYamlFilesFromStorageFolders ()

array< string, retrieveYamlFilesFromExtensionFolders():array { $filesFromExtensionFolders=[];foreach( $this->getAccessibleExtensionFolders() as $relativePath=> $fullPath) { foreach(new \DirectoryIterator( $fullPath) as $fileInfo) { if( $fileInfo->getExtension() !=='yaml') { continue;} $filesFromExtensionFolders[ $relativePath . $fileInfo->	getFilename ()]

Folder[]	getAccessibleFormStorageFolders ()

array	getAccessibleExtensionFolders ()

string	getUniquePersistenceIdentifier (string $formIdentifier, string $savePath)

string	getUniqueIdentifier (string $identifier)

bool	checkForDuplicateIdentifier (string $identifier)

bool	isAllowedPersistencePath (string $persistencePath)

Public Attributes
const	FORM_DEFINITION_FILE_EXTENSION = '.form.yaml'

return	$filesFromExtensionFolders

Protected Member Functions
bool	pathIsIntendedAsExtensionPath (string $path)

bool	pathIsIntendedAsFileMountPath (string $path)

File	getOrCreateFile (string $persistenceIdentifier)

ResourceStorage	getStorageByUid (int $storageUid)

array	loadMetaData ($persistenceIdentifier)

array	extractMetaDataFromCouldBeFormDefinition (string $maybeRawFormDefinition)

	generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension (array $formDefinition, string $persistenceIdentifier)

File	retrieveFileByPersistenceIdentifier (string $persistenceIdentifier)

bool	hasValidFileExtension (string $fileName)

bool	isFileWithinAccessibleExtensionFolders (string $fileName)

bool	isFileWithinAccessibleFormStorageFolders (string $fileName)

bool	isAccessibleExtensionFolder (string $folderName)

bool	isAccessibleFormStorageFolder (string $folderName)

bool	looksLikeAFormDefinition (array $data)

array	sortForms (array $forms)

Protected Attributes
TYPO3 CMS Form Mvc Configuration YamlSource	$yamlSource

TYPO3 CMS Core Resource StorageRepository	$storageRepository

array	$formSettings

FilePersistenceSlot	$filePersistenceSlot

FrontendInterface	$runtimeCache

ResourceFactory	$resourceFactory

Detailed Description

Concrete implementation of the FormPersistenceManagerInterface

Scope: frontend / backend

Definition at line 53 of file FormPersistenceManager.php.

Member Function Documentation

◆ checkForDuplicateIdentifier()

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

Check if an identifier is already used by a formDefinition.

Parameters

string $identifier

Returns: ‪bool

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

Definition at line 585 of file FormPersistenceManager.php.

References 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.

Parameters

string $persistenceIdentifier

Exceptions

PersistenceManagerException

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

Definition at line 212 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().

◆ exists()

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

Check whether a form with the specified $persistenceIdentifier exists

Parameters

string $persistenceIdentifier

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

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

protected

Parameters

string $maybeRawFormDefinition

Returns: ‪array

Definition at line 774 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

Parameters

array	$formDefinition
string	$persistenceIdentifier

Exceptions

PersistenceManagerException

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

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

Return a list of all accessible extension folders

Only registered mountpoints from TYPO3.CMS.Form.persistenceManager.allowedExtensionPaths are listed.

Returns: ‪array

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

Definition at line 477 of file FormPersistenceManager.php.

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

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

◆ 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 TYPO3.CMS.Form.persistenceManager.allowedFileMounts are listed.

Returns: ‪Folder[]

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

Definition at line 405 of file FormPersistenceManager.php.

References TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), and 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().

◆ getFilename()

array<string, retrieveYamlFilesFromExtensionFolders(): array { $filesFromExtensionFolders = []; foreach ($this->getAccessibleExtensionFolders() as $relativePath => $fullPath) { foreach (new \DirectoryIterator($fullPath) as $fileInfo) { if ($fileInfo->getExtension() !== 'yaml') { continue; } $filesFromExtensionFolders[$relativePath . $fileInfo-> TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::getFilename ( )

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

Returns: ‪array<string, string>

◆ getOrCreateFile()

File 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.

Parameters

string $persistenceIdentifier

Returns: ‪File

Exceptions

PersistenceManagerException

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

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

protected

Returns a ResourceStorage for a given uid

Parameters

int $storageUid

Returns: ‪ResourceStorage

Exceptions

PersistenceManagerException

Definition at line 722 of file FormPersistenceManager.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\isBrowsable().

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.

Parameters

string $identifier

Returns: ‪string unique form identifier

Exceptions

NoUniqueIdentifierException

Definition at line 557 of file FormPersistenceManager.php.

References 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
string	$savePath

Returns: ‪string unique form persistence identifier

Exceptions

NoUniquePersistenceIdentifierException

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

Definition at line 523 of file FormPersistenceManager.php.

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

◆ hasValidFileExtension()

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

protected

Parameters

string $fileName

Returns: ‪bool

Definition at line 856 of file FormPersistenceManager.php.

References TYPO3\CMS\Core\Utility\StringUtility\endsWith().

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

◆ initializeObject()

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

Definition at line 118 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_YAML_SETTINGS.

◆ injectFilePersistenceSlot()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::injectFilePersistenceSlot ( FilePersistenceSlot $filePersistenceSlot )

Parameters

\TYPO3\CMS\Form\Slot\FilePersistenceSlot $filePersistenceSlot

Definition at line 102 of file FormPersistenceManager.php.

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

◆ injectResourceFactory()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::injectResourceFactory ( ResourceFactory $resourceFactory )

Parameters

\TYPO3\CMS\Core\Resource\ResourceFactory $resourceFactory

Definition at line 110 of file FormPersistenceManager.php.

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

◆ injectStorageRepository()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::injectStorageRepository ( StorageRepository $storageRepository )

Parameters

\TYPO3\CMS\Core\Resource\StorageRepository $storageRepository

Definition at line 94 of file FormPersistenceManager.php.

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

◆ injectYamlSource()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager::injectYamlSource ( YamlSource $yamlSource )

Parameters

\TYPO3\CMS\Form\Mvc\Configuration\YamlSource $yamlSource

Definition at line 85 of file FormPersistenceManager.php.

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

◆ isAccessibleExtensionFolder()

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

protected

Parameters

string $folderName

Returns: ‪bool

Definition at line 889 of file FormPersistenceManager.php.

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

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

◆ isAccessibleFormStorageFolder()

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

protected

Parameters

string $folderName

Returns: ‪bool

Definition at line 899 of file FormPersistenceManager.php.

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

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

◆ isAllowedPersistencePath()

bool 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 (TYPO3.CMS.Form.persistenceManager.allowedExtensionPaths / TYPO3.CMS.Form.persistenceManager.allowedFileMounts). If the input is a persistence identifier an additional check for a valid file extension will be performed.

Parameters

string $persistencePath

Returns: ‪bool

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

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

protected

Parameters

string $fileName

Returns: ‪bool

Definition at line 865 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\exists(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ isFileWithinAccessibleFormStorageFolders()

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

protected

Parameters

string $fileName

Returns: ‪bool

Definition at line 877 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 275 of file FormPersistenceManager.php.

References 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\retrieveYamlFilesFromStorageFolders(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\sortForms().

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

◆ load()

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

Load the array formDefinition identified by $persistenceIdentifier, and return it. Only files with the extension .yaml or .form.yaml are loaded.

Parameters

string $persistenceIdentifier

Returns: ‪array

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

Definition at line 134 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier().

◆ loadMetaData()

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

protected

Parameters

string | File $persistenceIdentifier

Returns: ‪array

Exceptions

NoSuchFileException

Definition at line 739 of file FormPersistenceManager.php.

References TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\extractMetaDataFromCouldBeFormDefinition(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier().

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

◆ looksLikeAFormDefinition()

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

protected

Parameters

array $data

Returns: ‪bool

Definition at line 909 of file FormPersistenceManager.php.

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

◆ pathIsIntendedAsExtensionPath()

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

protected

Parameters

string $path

Returns: ‪bool

Definition at line 651 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\getAccessibleExtensionFolders(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\isAllowedPersistencePath(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveFileByPersistenceIdentifier(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\save().

◆ pathIsIntendedAsFileMountPath()

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

protected

Parameters

string $path

Returns: ‪bool

Definition at line 660 of file FormPersistenceManager.php.

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

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

◆ retrieveFileByPersistenceIdentifier()

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

protected

Parameters

string $persistenceIdentifier

Returns: ‪File

Exceptions

PersistenceManagerException
NoSuchFileException

Definition at line 820 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(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\loadMetaData().

◆ 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 345 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\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 TYPO3.CMS.Form.persistenceManager.allowSaveToExtensionPaths is set to true.

Parameters

string	$persistenceIdentifier
array	$formDefinition

Exceptions

PersistenceManagerException

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

Definition at line 174 of file FormPersistenceManager.php.

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

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

protected

Parameters

array $forms

Returns: ‪array

Definition at line 918 of file FormPersistenceManager.php.

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

Member Data Documentation

◆ $filePersistenceSlot

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

protected

Definition at line 71 of file FormPersistenceManager.php.

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

◆ $filesFromExtensionFolders

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

Definition at line 391 of file FormPersistenceManager.php.

◆ $formSettings

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

protected

Definition at line 67 of file FormPersistenceManager.php.

◆ $resourceFactory

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

protected

Definition at line 79 of file FormPersistenceManager.php.

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

◆ $runtimeCache

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

protected

Definition at line 75 of file FormPersistenceManager.php.

◆ $storageRepository

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

protected

Definition at line 63 of file FormPersistenceManager.php.

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

◆ $yamlSource

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

protected

Definition at line 59 of file FormPersistenceManager.php.

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

◆ FORM_DEFINITION_FILE_EXTENSION

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

Definition at line 55 of file FormPersistenceManager.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileProvider\canHandle(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getUniquePersistenceIdentifier(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\hasNewFileExtension(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\isFormDefinition(), TYPO3\CMS\Form\Hooks\FileListEditIconsHook\manipulateEditIcons(), and TYPO3\CMS\Form\Hooks\FormPagePreviewRenderer\preProcess().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ checkForDuplicateIdentifier()

◆ delete()

◆ exists()

◆ extractMetaDataFromCouldBeFormDefinition()

◆ generateErrorsIfFormDefinitionIsValidButHasInvalidFileExtension()

◆ getAccessibleExtensionFolders()

◆ getAccessibleFormStorageFolders()

◆ getFilename()

◆ getOrCreateFile()

◆ getStorageByUid()

◆ getUniqueIdentifier()

◆ getUniquePersistenceIdentifier()

◆ hasValidFileExtension()

◆ initializeObject()

◆ injectFilePersistenceSlot()

◆ injectResourceFactory()

◆ injectStorageRepository()

◆ injectYamlSource()

◆ isAccessibleExtensionFolder()

◆ isAccessibleFormStorageFolder()

◆ isAllowedPersistencePath()

◆ isFileWithinAccessibleExtensionFolders()

◆ isFileWithinAccessibleFormStorageFolders()

◆ listForms()

◆ load()

◆ loadMetaData()

◆ looksLikeAFormDefinition()

◆ pathIsIntendedAsExtensionPath()

◆ pathIsIntendedAsFileMountPath()

◆ retrieveFileByPersistenceIdentifier()

◆ retrieveYamlFilesFromStorageFolders()

◆ save()

◆ sortForms()

Member Data Documentation

◆ $filePersistenceSlot

◆ $filesFromExtensionFolders

◆ $formSettings

◆ $resourceFactory

◆ $runtimeCache

◆ $storageRepository

◆ $yamlSource

◆ FORM_DEFINITION_FILE_EXTENSION