FormPersistenceManagerInterface

The form persistence manager interface

Scope: frontend / backend

Table of Contents

Methods

checkForDuplicateIdentifier()  : bool
Check if an identifier is already used by a formDefinition.
delete()  : mixed
Delete the form representation identified by $persistenceIdentifier
exists()  : bool
Check whether a form with the specified $persistenceIdentifier exists
getAccessibleExtensionFolders()  : array<string|int, mixed>
Return a list of all accessible extension folders
getAccessibleFormStorageFolders()  : array<string|int, Folder>
Return a list of all accessible file mount points
getUniquePersistenceIdentifier()  : string
This takes a form identifier and returns a unique persistence identifier for it.
hasForms()  : bool
Check if any form definition is available
listForms()  : array<string|int, mixed>
List all form definitions which can be loaded through this form persistence manager.
load()  : array<string|int, mixed>
Load the array form representation identified by $persistenceIdentifier, and return it
save()  : mixed
Save the array form representation identified by $persistenceIdentifier

Methods

checkForDuplicateIdentifier()

Check if an identifier is already used by a formDefinition.

public checkForDuplicateIdentifier(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

delete()

Delete the form representation identified by $persistenceIdentifier

public delete(string $persistenceIdentifier) : mixed
Parameters
$persistenceIdentifier : string

exists()

Check whether a form with the specified $persistenceIdentifier exists

public exists(string $persistenceIdentifier) : bool
Parameters
$persistenceIdentifier : string
Return values
bool —

TRUE if a form with the given $persistenceIdentifier can be loaded, otherwise FALSE

getAccessibleExtensionFolders()

Return a list of all accessible extension folders

public getAccessibleExtensionFolders() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAccessibleFormStorageFolders()

Return a list of all accessible file mount points

public getAccessibleFormStorageFolders() : array<string|int, Folder>
Return values
array<string|int, Folder>

getUniquePersistenceIdentifier()

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

public getUniquePersistenceIdentifier(string $formIdentifier, string $savePath) : string
Parameters
$formIdentifier : string
$savePath : string
Return values
string

hasForms()

Check if any form definition is available

public hasForms() : bool
Return values
bool

listForms()

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

public listForms() : array<string|int, mixed>

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

Return values
array<string|int, mixed> —

in the format [['name' => 'Form 01', 'persistenceIdentifier' => 'path1'], [ .... ]]

load()

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

public load(string $persistenceIdentifier) : array<string|int, mixed>
Parameters
$persistenceIdentifier : string
Return values
array<string|int, mixed>

save()

Save the array form representation identified by $persistenceIdentifier

public save(string $persistenceIdentifier, array<string|int, mixed> $formDefinition) : mixed
Parameters
$persistenceIdentifier : string
$formDefinition : array<string|int, mixed> 

        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results