TYPO3\CMS\Form\Slot\FilePersistenceSlot Class Reference

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

Public Member Functions
	__construct (private readonly HashService $hashService)
	getContentSignature (string $content)
	defineInvocation (string $command, bool $type=null)
	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)
	searchAllowedInvocation (string $command, string $combinedFileIdentifier, string $contentSignature=null)
	buildCombinedIdentifier (FolderInterface $folder, string $fileName)
	isFormDefinition (string $identifier)
	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.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::__construct

(

private readonly HashService

$hashService

)

Definition at line 54 of file FilePersistenceSlot.php.

Member Function Documentation

allowInvocation()

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.

See also

‪getContentSignature

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

Exceptions

FormDefinitionPersistenceException

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

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

protected

Definition at line 281 of file FilePersistenceSlot.php.

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

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 71 of file FilePersistenceSlot.php.

getContentSignature()

TYPO3\CMS\Form\Slot\FilePersistenceSlot::getContentSignature

(

string

$content

)

Definition at line 56 of file FilePersistenceSlot.php.

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

isFormDefinition()

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

protected

Definition at line 291 of file FilePersistenceSlot.php.

References TYPO3\CMS\Webhooks\Message\$identifier, 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()

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

protected

Definition at line 299 of file FilePersistenceSlot.php.

References 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 125 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 111 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 173 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 145 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 159 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()

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

protected

Parameters

string | null

$contentSignature

Definition at line 264 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\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.

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\Mvc\Configuration\YamlSource\save().