Inheritance diagram for TYPO3\CMS\Form\Slot\FilePersistenceSlot:

Public Member Functions
string	getContentSignature (string $content)

	defineInvocation (string $command, bool $type=null)

bool	allowInvocation (string $command, string $combinedFileIdentifier, string $contentSignature=null)

	onPreFileCreate (BeforeFileCreatedEvent $event)

	onPreFileAdd (BeforeFileAddedEvent $event)

	onPreFileRename (BeforeFileRenamedEvent $event)

	onPreFileReplace (BeforeFileReplacedEvent $event)

	onPreFileMove (BeforeFileMovedEvent $event)

	onPreFileSetContents (BeforeFileContentsSetEvent $event)

Public Attributes
const	COMMAND_FILE_ADD = 'fileAdd'

const	COMMAND_FILE_CREATE = 'fileCreate'

const	COMMAND_FILE_MOVE = 'fileMove'

const	COMMAND_FILE_RENAME = 'fileRename'

const	COMMAND_FILE_REPLACE = 'fileReplace'

const	COMMAND_FILE_SET_CONTENTS = 'fileSetContents'

Protected Member Functions
	assertFileName (string $command, string $combinedFileIdentifier, string $content=null)

int null	searchAllowedInvocation (string $command, string $combinedFileIdentifier, string $contentSignature=null)

string	buildCombinedIdentifier (FolderInterface $folder, string $fileName)

bool	isFormDefinition (string $identifier)

bool	isRecycleFolder (FolderInterface $folder)

Protected Attributes
array	$definedInvocations = array( )

array	$allowedInvocations = array( )

Detailed Description

A PSR-14 event listener for various FAL related functionality.

will be renamed at some point.

Definition at line 37 of file FilePersistenceSlot.php.

Member Function Documentation

◆ allowInvocation()

bool TYPO3\CMS\Form\Slot\FilePersistenceSlot::allowInvocation	(	string	$command,
		string	$combinedFileIdentifier,
		string	$contentSignature = `null`
	)

Allows invocation for a particular combination of command and file identifier. Commands providing new content have have to submit a HMAC signature on the content as well.

Parameters

string	$command
string	$combinedFileIdentifier
string	$contentSignature

Returns: ‪bool

See also: ‪getContentSignature

Definition at line 92 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\searchAllowedInvocation().

◆ assertFileName()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::assertFileName	(	string	$command,
		string	$combinedFileIdentifier,
		string	$content = `null`
	)

protected

Parameters

string	$command
string	$combinedFileIdentifier
string	$content

Exceptions

FormDefinitionPersistenceException

Definition at line 217 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\getContentSignature(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\isFormDefinition(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\searchAllowedInvocation().

Referenced by TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileAdd(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileCreate(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileMove(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileRename(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileReplace(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileSetContents().

◆ buildCombinedIdentifier()

string TYPO3\CMS\Form\Slot\FilePersistenceSlot::buildCombinedIdentifier	(	FolderInterface	$folder,
		string	$fileName
	)

protected

Parameters

FolderInterface	$folder
string	$fileName

Returns: ‪string

Definition at line 292 of file FilePersistenceSlot.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileAdd(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileCreate(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileMove(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileRename(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileReplace(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileSetContents().

◆ defineInvocation()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::defineInvocation	(	string	$command,
		bool	$type = `null`
	)

Defines invocations on command level only depending on the type:

‪true: whitelist command, takes precedence over $allowedInvocations
‪false: blacklist command, takes precedence over $allowedInvocations
‪removes previously definition for particular command

Parameters

string	$command
bool \| null	$type

Definition at line 73 of file FilePersistenceSlot.php.

◆ getContentSignature()

string TYPO3\CMS\Form\Slot\FilePersistenceSlot::getContentSignature ( string $content )

Parameters

string $content

Returns: ‪string

Definition at line 58 of file FilePersistenceSlot.php.

Referenced by TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName().

◆ isFormDefinition()

bool TYPO3\CMS\Form\Slot\FilePersistenceSlot::isFormDefinition ( string $identifier )

protected

Parameters

string $identifier

Returns: ‪bool

Definition at line 306 of file FilePersistenceSlot.php.

References TYPO3\CMS\Core\Utility\StringUtility\endsWith(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\FORM_DEFINITION_FILE_EXTENSION.

Referenced by TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileAdd(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\onPreFileMove().

◆ isRecycleFolder()

bool TYPO3\CMS\Form\Slot\FilePersistenceSlot::isRecycleFolder ( FolderInterface $folder )

protected

Parameters

FolderInterface $folder

Returns: ‪bool

Definition at line 318 of file FilePersistenceSlot.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getRole(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), and TYPO3\CMS\Core\Resource\FolderInterface\ROLE_RECYCLER.

◆ onPreFileAdd()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::onPreFileAdd ( BeforeFileAddedEvent $event )

Definition at line 129 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\buildCombinedIdentifier(), TYPO3\CMS\Core\Resource\Event\BeforeFileAddedEvent\getFileName(), TYPO3\CMS\Core\Resource\Event\BeforeFileAddedEvent\getSourceFilePath(), TYPO3\CMS\Core\Resource\Event\BeforeFileAddedEvent\getTargetFolder(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\isFormDefinition().

◆ onPreFileCreate()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::onPreFileCreate ( BeforeFileCreatedEvent $event )

Definition at line 116 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\buildCombinedIdentifier(), TYPO3\CMS\Core\Resource\Event\BeforeFileCreatedEvent\getFileName(), and TYPO3\CMS\Core\Resource\Event\BeforeFileCreatedEvent\getFolder().

◆ onPreFileMove()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::onPreFileMove ( BeforeFileMovedEvent $event )

Definition at line 174 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\buildCombinedIdentifier(), TYPO3\CMS\Core\Resource\Event\BeforeFileMovedEvent\getFile(), TYPO3\CMS\Core\Resource\Event\BeforeFileMovedEvent\getFolder(), TYPO3\CMS\Core\Resource\Event\BeforeFileMovedEvent\getTargetFileName(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\isFormDefinition().

◆ onPreFileRename()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::onPreFileRename ( BeforeFileRenamedEvent $event )

Definition at line 148 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\buildCombinedIdentifier(), TYPO3\CMS\Core\Resource\Event\BeforeFileRenamedEvent\getFile(), and TYPO3\CMS\Core\Resource\Event\BeforeFileRenamedEvent\getTargetFileName().

◆ onPreFileReplace()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::onPreFileReplace ( BeforeFileReplacedEvent $event )

Definition at line 161 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\buildCombinedIdentifier(), and TYPO3\CMS\Core\Resource\Event\BeforeFileReplacedEvent\getFile().

◆ onPreFileSetContents()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::onPreFileSetContents ( BeforeFileContentsSetEvent $event )

Definition at line 197 of file FilePersistenceSlot.php.

References TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\buildCombinedIdentifier(), TYPO3\CMS\Core\Resource\Event\BeforeFileContentsSetEvent\getContent(), and TYPO3\CMS\Core\Resource\Event\BeforeFileContentsSetEvent\getFile().

◆ searchAllowedInvocation()

int null TYPO3\CMS\Form\Slot\FilePersistenceSlot::searchAllowedInvocation	(	string	$command,
		string	$combinedFileIdentifier,
		string	$contentSignature = `null`
	)

protected

Parameters

string	$command
string	$combinedFileIdentifier
string \| null	$contentSignature

Returns: ‪int|null

Definition at line 270 of file FilePersistenceSlot.php.

Referenced by TYPO3\CMS\Form\Slot\FilePersistenceSlot\allowInvocation(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\assertFileName().

Member Data Documentation

◆ $allowedInvocations

array TYPO3\CMS\Form\Slot\FilePersistenceSlot::$allowedInvocations = array( )

protected

Definition at line 52 of file FilePersistenceSlot.php.

◆ $definedInvocations

array TYPO3\CMS\Form\Slot\FilePersistenceSlot::$definedInvocations = array( )

protected

Definition at line 48 of file FilePersistenceSlot.php.

◆ COMMAND_FILE_ADD

const TYPO3\CMS\Form\Slot\FilePersistenceSlot::COMMAND_FILE_ADD = 'fileAdd'

Definition at line 39 of file FilePersistenceSlot.php.

Referenced by TYPO3\CMS\Form\Hooks\ImportExportHook\beforeAddSysFileRecordOnImport().

◆ COMMAND_FILE_CREATE

const TYPO3\CMS\Form\Slot\FilePersistenceSlot::COMMAND_FILE_CREATE = 'fileCreate'

Definition at line 40 of file FilePersistenceSlot.php.

Referenced by TYPO3\CMS\Form\Tests\Functional\Hooks\FormFileExtensionUpdateTest\createStorageFormDefinition(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getOrCreateFile().

◆ COMMAND_FILE_MOVE

const TYPO3\CMS\Form\Slot\FilePersistenceSlot::COMMAND_FILE_MOVE = 'fileMove'

Definition at line 41 of file FilePersistenceSlot.php.

◆ COMMAND_FILE_RENAME

const TYPO3\CMS\Form\Slot\FilePersistenceSlot::COMMAND_FILE_RENAME = 'fileRename'

Definition at line 42 of file FilePersistenceSlot.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate().

◆ COMMAND_FILE_REPLACE

const TYPO3\CMS\Form\Slot\FilePersistenceSlot::COMMAND_FILE_REPLACE = 'fileReplace'

Definition at line 43 of file FilePersistenceSlot.php.

◆ COMMAND_FILE_SET_CONTENTS

const TYPO3\CMS\Form\Slot\FilePersistenceSlot::COMMAND_FILE_SET_CONTENTS = 'fileSetContents'

Definition at line 44 of file FilePersistenceSlot.php.

Referenced by TYPO3\CMS\Form\Tests\Functional\Hooks\FormFileExtensionUpdateTest\createStorageFormDefinition(), and TYPO3\CMS\Form\Mvc\Configuration\YamlSource\save().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ allowInvocation()

◆ assertFileName()

◆ buildCombinedIdentifier()

◆ defineInvocation()

◆ getContentSignature()

◆ isFormDefinition()

◆ isRecycleFolder()

◆ onPreFileAdd()

◆ onPreFileCreate()

◆ onPreFileMove()

◆ onPreFileRename()

◆ onPreFileReplace()

◆ onPreFileSetContents()

◆ searchAllowedInvocation()

Member Data Documentation

◆ $allowedInvocations

◆ $definedInvocations

◆ COMMAND_FILE_ADD

◆ COMMAND_FILE_CREATE

◆ COMMAND_FILE_MOVE

◆ COMMAND_FILE_RENAME

◆ COMMAND_FILE_REPLACE

◆ COMMAND_FILE_SET_CONTENTS