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

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

Public Member Functions
	findByFile (File $file)
	findByFileUid ($uid)
	createMetaDataRecord ($fileUid, array $additionalFields=[])
	update ($fileUid, array $data)
	removeByFileUid ($fileUid)

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	getDatabaseConnection ()
	getGeneralWhereClause ()
	getSignalSlotDispatcher ()
	getObjectManager ()
	emitRecordPostRetrievalSignal (\ArrayObject $data)
	emitRecordUpdatedSignal (array $data)
	emitRecordCreatedSignal (array $data)
	emitRecordDeletedSignal ($fileUid)

Protected Attributes
	$tableName = 'sys_file_metadata'
	$tableFields = []

Detailed Description

Repository Class as an abstraction layer to sys_file_metadata

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

Definition at line 30 of file MetaDataRepository.php.

Member Function Documentation

createMetaDataRecord()

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

Create empty

Parameters

int	$fileUid
array	$additionalFields

Returns

array

Definition at line 128 of file MetaDataRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordCreatedSignal(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getDatabaseConnection().

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

emitRecordCreatedSignal()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::emitRecordCreatedSignal ( array  $data )

protected

Signal that is called after an IndexRecord is created

Parameters

array

$data

Definition at line 237 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getSignalSlotDispatcher().

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

emitRecordDeletedSignal()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::emitRecordDeletedSignal (   $fileUid )

protected

Signal that is called after an IndexRecord is deleted

Parameters

int

$fileUid

Definition at line 248 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getSignalSlotDispatcher().

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

emitRecordPostRetrievalSignal()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::emitRecordPostRetrievalSignal ( \ArrayObject  $data )

protected

Signal that is called after a record has been loaded from database Allows other places to do extension of metadata at runtime or for example translation and workspace overlay

Parameters

\ArrayObject

$data

Definition at line 215 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getSignalSlotDispatcher().

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

emitRecordUpdatedSignal()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::emitRecordUpdatedSignal ( array  $data )

protected

Signal that is called after an IndexRecord is updated

Parameters

array

$data

Definition at line 226 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getSignalSlotDispatcher().

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

findByFile()

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

(

File

$file

)

Returns array of meta-data properties

Parameters

File

$file

Returns

array

Definition at line 60 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_IMAGE, TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFileUid(), TYPO3\CMS\Core\Resource\AbstractFile\getForLocalProcessing(), TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), TYPO3\CMS\Core\Resource\AbstractFile\getType(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\update().

findByFileUid()

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

(

$uid

)

Retrieves metadata for file

Parameters

int

$uid

Returns

array

Exceptions

Definition at line 94 of file MetaDataRepository.php.

References $uid, TYPO3\CMS\Core\Resource\Index\MetaDataRepository\createMetaDataRecord(), TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordPostRetrievalSignal(), TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getDatabaseConnection(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getGeneralWhereClause().

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

getDatabaseConnection()

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

protected

Wrapper method for getting DatabaseConnection

Returns

Definition at line 49 of file MetaDataRepository.php.

References $GLOBALS.

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

getGeneralWhereClause()

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

protected

General Where-Clause which is needed to fetch only language 0 and live record.

Returns

string

Definition at line 116 of file MetaDataRepository.php.

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

getInstance()

static TYPO3\CMS\Core\Resource\Index\MetaDataRepository::getInstance ( )

static

Returns

Definition at line 256 of file MetaDataRepository.php.

Referenced by TYPO3\CMS\Core\Resource\Index\Indexer\getMetaDataRepository().

getObjectManager()

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

protected

Get the ObjectManager

Returns

Definition at line 202 of file MetaDataRepository.php.

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

getSignalSlotDispatcher()

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

protected

Get the SignalSlot dispatcher

Returns

Definition at line 192 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getObjectManager().

Referenced by TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordCreatedSignal(), TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordDeletedSignal(), TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordPostRetrievalSignal(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordUpdatedSignal().

removeByFileUid()

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

(

$fileUid

)

Remove all metadata records for a certain file from the database

Parameters

int

$fileUid

Returns

void

Definition at line 181 of file MetaDataRepository.php.

References TYPO3\CMS\Core\Resource\Index\MetaDataRepository\emitRecordDeletedSignal(), and TYPO3\CMS\Core\Resource\Index\MetaDataRepository\getDatabaseConnection().

update()

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::update	(		$fileUid,
		array	$data
	)

Updates the metadata record in the database

Parameters

int	$fileUid	the file uid to update
array	$data	Data to update

Returns

void

Definition at line 157 of file MetaDataRepository.php.

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

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

Member Data Documentation

$tableFields

TYPO3\CMS\Core\Resource\Index\MetaDataRepository::$tableFields = []

protected

Definition at line 42 of file MetaDataRepository.php.

$tableName

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

protected

Definition at line 35 of file MetaDataRepository.php.