TYPO3\CMS\Core\Resource\Index\MetaDataRepository Class Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\Index\MetaDataRepository:

Public Member Functions
	__construct (protected readonly EventDispatcherInterface $eventDispatcher,)
array	findByFile (File $file)
array	findByFileUid ($uid)
array	createMetaDataRecord ($fileUid, array $additionalFields=[])
array	update ($fileUid, array $updateData, ?array $metaDataFromDatabase=null)
	removeByFileUid ($fileUid)

Protected Member Functions
	getTableFields ()

Protected Attributes
string	$tableName = 'sys_file_metadata'
array	$tableFields = array( )

Detailed Description

Repository Class as an abstraction layer to sys_file_metadata

Every access to table sys_file_metadata which is not handled by DataHandler has to use this Repository class

Definition at line 39 of file MetaDataRepository.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::__construct

(

protected readonly EventDispatcherInterface

$eventDispatcher

)

Definition at line 51 of file MetaDataRepository.php.

Member Function Documentation

createMetaDataRecord()

array TYPO3\CMS\Core\Resource\Index\MetaDataRepository::createMetaDataRecord	(		$fileUid,
		array	$additionalFields = []
	)

Create empty

Parameters

int

$fileUid

Returns

‪array

Definition at line 130 of file MetaDataRepository.php.

References $GLOBALS, TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getTableFields(), and TYPO3\CMS\Core\Database\Connection\PARAM_LOB.

findByFile()

array TYPO3\CMS\Core\Resource\Index\MetaDataRepository::findByFile

(

File

$file

)

Returns array of meta-data properties

Returns

‪array

Definition at line 60 of file MetaDataRepository.php.

References $GLOBALS, TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFileUid(), TYPO3\CMS\Core\Resource\AbstractFile\getForLocalProcessing(), TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), TYPO3\CMS\Core\Resource\AbstractFile\isType(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\update().

findByFileUid()

array TYPO3\CMS\Core\Resource\Index\MetaDataRepository::findByFileUid

(

$uid

)

Retrieves metadata for file

Parameters

int

$uid

Returns

‪array

Exceptions

InvalidUidException

Definition at line 96 of file MetaDataRepository.php.

References TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Webhooks\Message\$uid, TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Database\Connection\PARAM_INT_ARRAY.

Referenced by TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFile(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\update().

getTableFields()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::getTableFields ( )

protected

Gets the fields that are available in the table

Definition at line 220 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\$tableFields.

Referenced by TYPO3\CMS\Core\Resource\Index\MetaDataRepository\createMetaDataRecord(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\update().

removeByFileUid()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::removeByFileUid

(

$fileUid

)

Remove all metadata records for a certain file from the database

Parameters

int

$fileUid

Definition at line 203 of file MetaDataRepository.php.

update()

array TYPO3\CMS\Core\Resource\Index\MetaDataRepository::update	(		$fileUid,
		array	$updateData,
		?array	$metaDataFromDatabase = null
	)

Updates the metadata record in the database

Parameters

int	$fileUid	‪the file uid to update
array	$updateData	‪Data to update
	?array	‪$metaDataFromDatabase Current meta data from database

Returns

‪array The updated database record - or just $metaDataFromDatabase if no update was done

Definition at line 164 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFileUid(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getTableFields().

Referenced by TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFile().

Member Data Documentation

$tableFields

array TYPO3\CMS\Core\Resource\Index\MetaDataRepository::$tableFields = array( )

protected

Internal storage for database table fields

Definition at line 49 of file MetaDataRepository.php.

Referenced by TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getTableFields().

$tableName

string TYPO3\CMS\Core\Resource\Index\MetaDataRepository::$tableName = 'sys_file_metadata'

protected

Definition at line 43 of file MetaDataRepository.php.