TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface Interface Reference

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

Public Member Functions
array	load (string $persistenceIdentifier)
	save (string $persistenceIdentifier, array $formDefinition)
bool	exists (string $persistenceIdentifier)
	delete (string $persistenceIdentifier)
array	listForms ()
Folder[]	getAccessibleFormStorageFolders ()
array	getAccessibleExtensionFolders ()
string	getUniquePersistenceIdentifier (string $formIdentifier, string $savePath)
bool	checkForDuplicateIdentifier (string $identifier)

Detailed Description

The form persistence manager interface

Scope: frontend / backend

Definition at line 31 of file FormPersistenceManagerInterface.php.

Member Function Documentation

checkForDuplicateIdentifier()

bool TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::checkForDuplicateIdentifier

(

string

$identifier

)

Check if an identifier is already used by a formDefinition.

Parameters

string

$identifier

Returns

‪bool

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

delete()

TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::delete

(

string

$persistenceIdentifier

)

Delete the form representation identified by $persistenceIdentifier

Parameters

string

$persistenceIdentifier

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

exists()

bool TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::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

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

getAccessibleExtensionFolders()

array TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::getAccessibleExtensionFolders

(

)

Return a list of all accessible extension folders

Returns

‪array

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

getAccessibleFormStorageFolders()

Folder [] TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::getAccessibleFormStorageFolders

(

)

Return a list of all accessible file mount points

Returns

‪Folder[]

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

getUniquePersistenceIdentifier()

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

This takes a form identifier and returns a unique persistence identifier for it.

Parameters

string	$formIdentifier
string	$savePath

Returns

‪string

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

listForms()

array TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::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'], [ .... ]]

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

load()

array TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface::load

(

string

$persistenceIdentifier

)

Load the array form representation identified by $persistenceIdentifier, and return it

Parameters

string

$persistenceIdentifier

Returns

‪array

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.

save()

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

Save the array form representation identified by $persistenceIdentifier

Parameters

string	$persistenceIdentifier
array	$formDefinition

Implemented in TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager.