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

Public Member Functions
array bool	findOneByCombinedIdentifier ($combinedIdentifier)

array bool	findOneByUid ($fileUid)

array bool	findOneByStorageUidAndIdentifier ($storageUid, $identifier)

array bool	findOneByStorageUidAndIdentifierHash ($storageUid, $identifierHash)

array bool	findOneByFileObject (FileInterface $fileObject)

mixed	findByContentHash ($hash)

array null	findByFolder (Folder $folder)

array null	findByFolders (array $folders, $includeMissing=true, $fileName=null)

	add (File $file)

array	addRaw (array $data)

bool	hasIndexRecord (File $file)

	update (File $file)

array	findInStorageWithIndexOutstanding (ResourceStorage $storage, $limit=-1)

array	findInStorageAndNotInUidList (ResourceStorage $storage, array $uidList)

	updateIndexingTime ($fileUid)

	markFileAsMissing ($fileUid)

	remove ($fileUid)

	updateRefIndex ($id)

array	findBySearchWordInMetaData ($searchWord)

Static Public Member Functions
static FileIndexRepository	getInstance ()

Protected Member Functions
ResourceFactory	getResourceFactory ()

int	insertRecord (array $data)

Dispatcher	getSignalSlotDispatcher ()

ObjectManager	getObjectManager ()

	emitRecordUpdatedSignal (array $data)

	emitRecordCreatedSignal (array $data)

	emitRecordDeletedSignal ($fileUid)

	emitRecordMarkedAsMissingSignal ($fileUid)

Protected Attributes
string	$table = 'sys_file'

array	$fields

Detailed Description

Repository Class as an abstraction layer to sys_file

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

This is meant for FAL internal use only!

Definition at line 40 of file FileIndexRepository.php.

Member Function Documentation

◆ add()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::add ( File $file )

Adds a file to the index

Parameters

File $file

Definition at line 307 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\File\_getPropertyRaw(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByFileObject(), TYPO3\CMS\Core\Resource\File\getProperties(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\hasIndexRecord(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\insertRecord(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\update(), and TYPO3\CMS\Core\Resource\File\updateProperties().

◆ addRaw()

array TYPO3\CMS\Core\Resource\Index\FileIndexRepository::addRaw ( array $data )

Add data from record (at indexing time)

Parameters

array $data

Returns: ‪array

Definition at line 325 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\insertRecord().

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

◆ emitRecordCreatedSignal()

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

protected

Signal that is called after an IndexRecord is created

Parameters

array $data

Definition at line 616 of file FileIndexRepository.php.

References TYPO3\CMS\Extbase\SignalSlot\Dispatcher\dispatch(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getSignalSlotDispatcher().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\insertRecord().

◆ emitRecordDeletedSignal()

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

protected

Signal that is called after an IndexRecord is deleted

Parameters

int $fileUid

Definition at line 626 of file FileIndexRepository.php.

References TYPO3\CMS\Extbase\SignalSlot\Dispatcher\dispatch(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getSignalSlotDispatcher().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\remove().

◆ emitRecordMarkedAsMissingSignal()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::emitRecordMarkedAsMissingSignal ( $fileUid )

protected

Signal that is called after an IndexRecord is marked as missing

Parameters

int $fileUid

Definition at line 636 of file FileIndexRepository.php.

References TYPO3\CMS\Extbase\SignalSlot\Dispatcher\dispatch(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getSignalSlotDispatcher().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\markFileAsMissing().

◆ emitRecordUpdatedSignal()

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

protected

Signal that is called after an IndexRecord is updated

Parameters

array $data

Definition at line 606 of file FileIndexRepository.php.

References TYPO3\CMS\Extbase\SignalSlot\Dispatcher\dispatch(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getSignalSlotDispatcher().

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

◆ findByContentHash()

mixed TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findByContentHash ( $hash )

Returns all indexed files which match the content hash Used by the indexer to detect already present files

Parameters

string $hash

Returns: ‪mixed

Definition at line 174 of file FileIndexRepository.php.

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId(), and TYPO3\CMS\Core\Resource\Index\Indexer\processChangedAndNewFiles().

◆ findByFolder()

array null TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findByFolder ( Folder $folder )

Find all records for files in a Folder

Parameters

Folder $folder

Returns: ‪array|null

Definition at line 201 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Folder\getHashedIdentifier(), TYPO3\CMS\Core\Resource\Folder\getStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFilesInFolder().

◆ findByFolders()

array null TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findByFolders	(	array	$folders,
			$includeMissing = `true`,
			$fileName = `null`
	)

Find all records for files in an array of Folders

Parameters

Folder[]	$folders
bool	$includeMissing
string	$fileName

Returns: ‪array|null

Definition at line 237 of file FileIndexRepository.php.

◆ findBySearchWordInMetaData()

array TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findBySearchWordInMetaData ( $searchWord )

Search for files by search word in metadata

Parameters

string $searchWord ‪search word

Deprecated:: ‪Use FileSearchQuery instead

Returns: ‪array

Definition at line 567 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Search\FileSearchQuery\createForSearchDemand(), and TYPO3\CMS\Core\Resource\Search\FileSearchDemand\createForSearchTerm().

◆ findInStorageAndNotInUidList()

array TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findInStorageAndNotInUidList	(	ResourceStorage	$storage,
		array	$uidList
	)

Helper function for the Indexer to detect missing files

Parameters

ResourceStorage	$storage
int[]	$uidList

Returns: ‪array

Definition at line 462 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

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

◆ findInStorageWithIndexOutstanding()

array TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findInStorageWithIndexOutstanding	(	ResourceStorage	$storage,
			$limit = `-1`
	)

Finds the files needed for second indexer step

Parameters

ResourceStorage	$storage
int	$limit

Returns: ‪array

Definition at line 433 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

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

◆ findOneByCombinedIdentifier()

array bool TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findOneByCombinedIdentifier ( $combinedIdentifier )

Retrieves Index record for a given $combinedIdentifier

Parameters

string $combinedIdentifier

Returns: ‪array|bool

Definition at line 81 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifier().

◆ findOneByFileObject()

array bool TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findOneByFileObject ( FileInterface $fileObject )

Retrieves Index record for a given $fileObject

Parameters

FileInterface $fileObject

Returns: ‪array|bool

only for use from FileRepository

Definition at line 160 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifierHash(), TYPO3\CMS\Core\Resource\ResourceInterface\getHashedIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add().

◆ findOneByStorageUidAndIdentifier()

array bool TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findOneByStorageUidAndIdentifier	(	$storageUid,
		$identifier
	)

Retrieves Index record for a given $storageUid and $identifier

Parameters

int	$storageUid
string	$identifier

Returns: ‪array|bool

only for use from FileRepository

Definition at line 119 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifierHash(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getResourceFactory(), TYPO3\CMS\Core\Resource\ResourceFactory\getStorageObject(), and TYPO3\CMS\Core\Resource\ResourceStorage\hashFileIdentifier().

Referenced by TYPO3\CMS\Core\Resource\Index\Indexer\detectChangedFilesInStorage(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByCombinedIdentifier(), and TYPO3\CMS\Core\Resource\ResourceFactory\getFileObjectByStorageAndIdentifier().

◆ findOneByStorageUidAndIdentifierHash()

array bool TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findOneByStorageUidAndIdentifierHash	(	$storageUid,
		$identifierHash
	)

Retrieves Index record for a given $storageUid and $identifier

Parameters

int	$storageUid
string	$identifierHash

Returns: ‪array|bool

only for use from FileRepository

Definition at line 134 of file FileIndexRepository.php.

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByFileObject(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifier().

◆ findOneByUid()

array bool TYPO3\CMS\Core\Resource\Index\FileIndexRepository::findOneByUid ( $fileUid )

Retrieves Index record for a given $fileUid

Parameters

int $fileUid

Returns: ‪array|bool

Definition at line 93 of file FileIndexRepository.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceFactory\getFileObject().

◆ getInstance()

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

static

Returns an Instance of the Repository

Returns: ‪FileIndexRepository

Definition at line 70 of file FileIndexRepository.php.

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\getFileIndexRepository(), TYPO3\CMS\Core\Resource\FileRepository\getFileIndexRepository(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileIndexRepository(), and TYPO3\CMS\Core\Resource\ResourceStorage\getFileIndexRepository().

◆ getObjectManager()

ObjectManager TYPO3\CMS\Core\Resource\Index\FileIndexRepository::getObjectManager ( )

protected

Get the ObjectManager

Returns: ‪ObjectManager

Definition at line 596 of file FileIndexRepository.php.

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

◆ getResourceFactory()

ResourceFactory TYPO3\CMS\Core\Resource\Index\FileIndexRepository::getResourceFactory ( )

protected

Gets the Resource Factory

Returns: ‪ResourceFactory

Definition at line 60 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\ResourceFactory\getInstance().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifier().

◆ getSignalSlotDispatcher()

Dispatcher TYPO3\CMS\Core\Resource\Index\FileIndexRepository::getSignalSlotDispatcher ( )

protected

Get the SignalSlot dispatcher

Returns: ‪Dispatcher

Definition at line 586 of file FileIndexRepository.php.

References TYPO3\CMS\Extbase\Object\ObjectManager\get(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getObjectManager().

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

◆ hasIndexRecord()

bool TYPO3\CMS\Core\Resource\Index\FileIndexRepository::hasIndexRecord ( File $file )

Checks if a file is indexed

Parameters

File $file

Returns: ‪bool

Definition at line 359 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\File\_getPropertyRaw(), TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add().

◆ insertRecord()

int TYPO3\CMS\Core\Resource\Index\FileIndexRepository::insertRecord ( array $data )

protected

Helper to reduce code duplication

Parameters

array $data

Returns: ‪int

Definition at line 338 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\emitRecordCreatedSignal(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\updateRefIndex().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\addRaw().

◆ markFileAsMissing()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::markFileAsMissing ( $fileUid )

Marks given file as missing in sys_file

Parameters

int $fileUid

Definition at line 514 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\emitRecordMarkedAsMissingSignal().

Referenced by TYPO3\CMS\Core\Resource\Index\Indexer\detectMissingFiles(), and TYPO3\CMS\Core\Resource\Index\Indexer\runMetaDataExtraction().

◆ remove()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::remove ( $fileUid )

Remove a sys_file record from the database

Parameters

int $fileUid

Definition at line 534 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\emitRecordDeletedSignal(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\updateRefIndex().

Referenced by TYPO3\CMS\Core\Resource\Processing\FileDeletionAspect\removeFromRepository().

◆ update()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::update ( File $file )

Updates the index record in the database

Parameters

File $file

Definition at line 395 of file FileIndexRepository.php.

References TYPO3\CMS\Core\Resource\File\_getPropertyRaw(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\emitRecordUpdatedSignal(), TYPO3\CMS\Core\Resource\File\getProperties(), TYPO3\CMS\Core\Resource\File\getProperty(), TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), TYPO3\CMS\Core\Resource\ResourceStorage\getUid(), TYPO3\CMS\Core\Resource\File\getUpdatedProperties(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\updateRefIndex().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

◆ updateIndexingTime()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::updateIndexingTime ( $fileUid )

Updates the timestamp when the file indexer extracted metadata

Parameters

int $fileUid

Definition at line 495 of file FileIndexRepository.php.

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

◆ updateRefIndex()

TYPO3\CMS\Core\Resource\Index\FileIndexRepository::updateRefIndex ( $id )

Update Reference Index (sys_refindex) for a file

Parameters

int $id ‪Record UID

Definition at line 552 of file FileIndexRepository.php.

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\insertRecord(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\remove(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\update().

Member Data Documentation

◆ $fields

array TYPO3\CMS\Core\Resource\Index\FileIndexRepository::$fields

protected

Initial value:

= array( 
        'uid', 'pid', 'missing', 'type', 'storage', 'identifier', 'identifier_hash', 'extension',
        'mime_type', 'name', 'sha1', 'size', 'creation_date', 'modification_date', 'folder_hash'
     )

A list of properties which are to be persisted

Definition at line 50 of file FileIndexRepository.php.

◆ $table

string TYPO3\CMS\Core\Resource\Index\FileIndexRepository::$table = 'sys_file'

protected

Definition at line 44 of file FileIndexRepository.php.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ addRaw()

◆ emitRecordCreatedSignal()

◆ emitRecordDeletedSignal()

◆ emitRecordMarkedAsMissingSignal()

◆ emitRecordUpdatedSignal()

◆ findByContentHash()

◆ findByFolder()

◆ findByFolders()

◆ findBySearchWordInMetaData()

◆ findInStorageAndNotInUidList()

◆ findInStorageWithIndexOutstanding()

◆ findOneByCombinedIdentifier()

◆ findOneByFileObject()

◆ findOneByStorageUidAndIdentifier()

◆ findOneByStorageUidAndIdentifierHash()

◆ findOneByUid()

◆ getInstance()

◆ getObjectManager()

◆ getResourceFactory()

◆ getSignalSlotDispatcher()

◆ hasIndexRecord()

◆ insertRecord()

◆ markFileAsMissing()

◆ remove()

◆ update()

◆ updateIndexingTime()

◆ updateRefIndex()

Member Data Documentation

◆ $fields

◆ $table