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

Public Member Functions
	__construct (ResourceStorage $storage)

	createIndexEntry ($identifier)

	updateIndexEntry (File $fileObject)

	processChangesInStorages ()

	runMetaDataExtraction ($maximumFileCount=-1)

	extractMetaData (File $fileObject)

Protected Member Functions
	detectMissingFiles ()

bool	isFileTypeSupportedByExtractor (File $file, ExtractorInterface $extractor)

	detectChangedFilesInStorage (array $fileIdentifierArray)

	processChangedAndNewFiles ()

	extractRequiredMetaData (File $fileObject)

	gatherFileInformationArray ($identifier)

	getFileType (string $mimeType)

array	transformFromDriverFileInfoArrayToFileObjectFormat (array $fileInfo)

FileIndexRepository	getFileIndexRepository ()

MetaDataRepository	getMetaDataRepository ()

ResourceFactory	getResourceFactory ()

	getExtractorService ()

Protected Attributes
array	$filesToUpdate = array( )

int[]	$identifiedFileUids = array( )

ResourceStorage	$storage

ExtractorService	$extractorService

Detailed Description

The FAL Indexer

Definition at line 34 of file Indexer.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\Index\Indexer::__construct ( ResourceStorage $storage )

Definition at line 54 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\$storage.

Member Function Documentation

◆ createIndexEntry()

TYPO3\CMS\Core\Resource\Index\Indexer::createIndexEntry ( $identifier )

Create index entry

Parameters

string $identifier

Exceptions

Definition at line 65 of file Indexer.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), TYPO3\CMS\Core\Resource\Index\Indexer\extractRequiredMetaData(), TYPO3\CMS\Core\Resource\Index\Indexer\gatherFileInformationArray(), TYPO3\CMS\Core\Resource\Index\Indexer\getExtractorService(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileObject(), and TYPO3\CMS\Core\Resource\Index\Indexer\getResourceFactory().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFileByIdentifier(), and TYPO3\CMS\Core\Resource\Index\Indexer\processChangedAndNewFiles().

◆ detectChangedFilesInStorage()

TYPO3\CMS\Core\Resource\Index\Indexer::detectChangedFilesInStorage ( array $fileIdentifierArray )

protected

Adds updated files to the processing queue

Definition at line 203 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageAndIdentifier(), and TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository().

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

◆ detectMissingFiles()

TYPO3\CMS\Core\Resource\Index\Indexer::detectMissingFiles ( )

protected

Since by now all files in filesystem have been looked at, it is safe to assume, that files that are indexed, but not touched in this run, are missing

Definition at line 163 of file Indexer.php.

References TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findInStorageAndNotInUidList(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\markFileAsMissing().

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

◆ extractMetaData()

TYPO3\CMS\Core\Resource\Index\Indexer::extractMetaData ( File $fileObject )

Extract metadata for given fileObject

Definition at line 148 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\File\getMetaData(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\updateIndexingTime().

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

◆ extractRequiredMetaData()

TYPO3\CMS\Core\Resource\Index\Indexer::extractRequiredMetaData ( File $fileObject )

protected

Since the core desperately needs image sizes in metadata table put them there This should be called after every "content" update and "record" creation

Definition at line 284 of file Indexer.php.

References TYPO3\CMS\Core\Resource\AbstractFile\getForLocalProcessing(), and TYPO3\CMS\Core\Resource\AbstractFile\isImage().

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

◆ gatherFileInformationArray()

TYPO3\CMS\Core\Resource\Index\Indexer::gatherFileInformationArray ( $identifier )

protected

Collects the information to be cached in sys_file

Parameters

string $identifier

Exceptions

Definition at line 311 of file Indexer.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Core\Resource\Index\Indexer\getFileType(), and TYPO3\CMS\Core\Resource\Index\Indexer\transformFromDriverFileInfoArrayToFileObjectFormat().

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

◆ getExtractorService()

TYPO3\CMS\Core\Resource\Index\Indexer::getExtractorService ( )

protected

Definition at line 391 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\$extractorService.

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

◆ getFileIndexRepository()

FileIndexRepository TYPO3\CMS\Core\Resource\Index\Indexer::getFileIndexRepository ( )

protected

Returns an instance of the FileIndexRepository

Returns: ‪FileIndexRepository

Definition at line 366 of file Indexer.php.

Referenced by TYPO3\CMS\Core\Resource\Index\Indexer\createIndexEntry(), TYPO3\CMS\Core\Resource\Index\Indexer\detectChangedFilesInStorage(), TYPO3\CMS\Core\Resource\Index\Indexer\detectMissingFiles(), TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), TYPO3\CMS\Core\Resource\Index\Indexer\processChangedAndNewFiles(), TYPO3\CMS\Core\Resource\Index\Indexer\runMetaDataExtraction(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

◆ getFileType()

TYPO3\CMS\Core\Resource\Index\Indexer::getFileType ( string $mimeType )

protected

Maps the mimetype to a sys_file table type

Definition at line 325 of file Indexer.php.

References TYPO3\CMS\Core\Resource\tryFromMimeType.

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

◆ getMetaDataRepository()

MetaDataRepository TYPO3\CMS\Core\Resource\Index\Indexer::getMetaDataRepository ( )

protected

Returns an instance of the FileIndexRepository

Returns: ‪MetaDataRepository

Definition at line 376 of file Indexer.php.

◆ getResourceFactory()

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

protected

Returns the ResourceFactory

Returns: ‪ResourceFactory

Definition at line 386 of file Indexer.php.

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

◆ isFileTypeSupportedByExtractor()

bool TYPO3\CMS\Core\Resource\Index\Indexer::isFileTypeSupportedByExtractor	(	File	$file,
		ExtractorInterface	$extractor
	)

protected

Check whether the extractor service supports this file according to file type restrictions.

Returns: ‪bool

Definition at line 190 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\ExtractorInterface\getFileTypeRestrictions(), and TYPO3\CMS\Core\Resource\AbstractFile\getType().

◆ processChangedAndNewFiles()

TYPO3\CMS\Core\Resource\Index\Indexer::processChangedAndNewFiles ( )

protected

Processes the Files which have been detected as "changed or new" in the storage

Definition at line 231 of file Indexer.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Core\Resource\Index\Indexer\createIndexEntry(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findByContentHash(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileObject(), TYPO3\CMS\Core\Resource\Index\Indexer\getResourceFactory(), TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry(), and TYPO3\CMS\Core\Resource\File\updateProperties().

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

◆ processChangesInStorages()

TYPO3\CMS\Core\Resource\Index\Indexer::processChangesInStorages ( )

Definition at line 111 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\detectChangedFilesInStorage(), TYPO3\CMS\Core\Resource\Index\Indexer\detectMissingFiles(), and TYPO3\CMS\Core\Resource\Index\Indexer\processChangedAndNewFiles().

◆ runMetaDataExtraction()

TYPO3\CMS\Core\Resource\Index\Indexer::runMetaDataExtraction ( $maximumFileCount = -1 )

Parameters

int $maximumFileCount

Definition at line 124 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findInStorageWithIndexOutstanding(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileObject(), TYPO3\CMS\Core\Resource\Index\Indexer\getResourceFactory(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\markFileAsMissing().

◆ transformFromDriverFileInfoArrayToFileObjectFormat()

array TYPO3\CMS\Core\Resource\Index\Indexer::transformFromDriverFileInfoArrayToFileObjectFormat ( array $fileInfo )

protected

However it happened, the properties of a file object which are persisted to the database are named different than the properties the driver returns in getFileInfo. Therefore a mapping must happen.

Returns: ‪array

Definition at line 338 of file Indexer.php.

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

◆ updateIndexEntry()

TYPO3\CMS\Core\Resource\Index\Indexer::updateIndexEntry ( File $fileObject )

Update index entry

Definition at line 93 of file Indexer.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addFile(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\func_upload(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFile(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Core\Resource\Index\Indexer\processChangedAndNewFiles(), TYPO3\CMS\Core\Resource\ResourceStorage\renameFile(), TYPO3\CMS\Core\Resource\ResourceStorage\renameFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\replaceFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\setFileContents().

Member Data Documentation

◆ $extractorService

ExtractorService TYPO3\CMS\Core\Resource\Index\Indexer::$extractorService

protected

Definition at line 52 of file Indexer.php.

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

◆ $filesToUpdate

array TYPO3\CMS\Core\Resource\Index\Indexer::$filesToUpdate = array( )

protected

Definition at line 40 of file Indexer.php.

◆ $identifiedFileUids

int [] TYPO3\CMS\Core\Resource\Index\Indexer::$identifiedFileUids = array( )

protected

Definition at line 44 of file Indexer.php.

◆ $storage

ResourceStorage TYPO3\CMS\Core\Resource\Index\Indexer::$storage

protected

Definition at line 48 of file Indexer.php.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createIndexEntry()

◆ detectChangedFilesInStorage()

◆ detectMissingFiles()

◆ extractMetaData()

◆ extractRequiredMetaData()

◆ gatherFileInformationArray()

◆ getExtractorService()

◆ getFileIndexRepository()

◆ getFileType()

◆ getMetaDataRepository()

◆ getResourceFactory()

◆ isFileTypeSupportedByExtractor()

◆ processChangedAndNewFiles()

◆ processChangesInStorages()

◆ runMetaDataExtraction()

◆ transformFromDriverFileInfoArrayToFileObjectFormat()

◆ updateIndexEntry()

Member Data Documentation

◆ $extractorService

◆ $filesToUpdate

◆ $identifiedFileUids

◆ $storage