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

Public Member Functions
	__construct (ResourceStorage $storage)

File	createIndexEntry ($identifier)

File	updateIndexEntry (File $fileObject)

	processChangesInStorages ()

	runMetaDataExtraction ($maximumFileCount=-1)

	extractMetaData (File $fileObject)

Protected Member Functions
	detectMissingFiles ()

bool	isFileTypeSupportedByExtractor (File $file, ExtractorInterface $extractor)

	detectChangedFilesInStorage (array $fileIdentifierArray)

	processChangedAndNewFiles ()

array	extractRequiredMetaData (File $fileObject)

array	gatherFileInformationArray ($identifier)

string	getFileType ($mimeType)

array	transformFromDriverFileInfoArrayToFileObjectFormat (array $fileInfo)

FileIndexRepository	getFileIndexRepository ()

MetaDataRepository	getMetaDataRepository ()

ResourceFactory	getResourceFactory ()

ExtractorService	getExtractorService ()

Protected Attributes
array	$filesToUpdate = array( )

int[]	$identifiedFileUids = array( )

ResourceStorage	$storage

ExtractorService	$extractorService

Detailed Description

The FAL Indexer

Definition at line 33 of file Indexer.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ResourceStorage $storage

Definition at line 56 of file Indexer.php.

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

Member Function Documentation

◆ createIndexEntry()

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

Create index entry

Parameters

string $identifier

Returns: ‪File

Exceptions

Definition at line 68 of file Indexer.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceFactory\getFileObjectByStorageAndIdentifier(), 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

Parameters

array $fileIdentifierArray

Definition at line 202 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifier(), 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 save to assume, that files that are in indexed but not touched in this run are missing

Definition at line 166 of file Indexer.php.

References 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

Parameters

File $fileObject

Definition at line 151 of file Indexer.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\add(), TYPO3\CMS\Core\Resource\MetaDataAspect\get(), 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()

array 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

Parameters

File $fileObject

Returns: ‪array

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

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

protected

Collects the information to be cached in sys_file

Parameters

string $identifier

Returns: ‪array

Exceptions

Definition at line 312 of file Indexer.php.

References 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()

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

protected

Returns: ‪ExtractorService

Definition at line 420 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 392 of file Indexer.php.

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

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()

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

protected

Maps the mimetype to a sys_file table type

Parameters

string $mimeType

Returns: ‪string

Definition at line 329 of file Indexer.php.

References TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_APPLICATION, TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_AUDIO, TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_IMAGE, TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_TEXT, TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_UNKNOWN, and TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_VIDEO.

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 402 of file Indexer.php.

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

◆ getResourceFactory()

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

protected

Returns the ResourceFactory

Returns: ‪ResourceFactory

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

Parameters

File	$file
ExtractorInterface	$extractor

Returns: ‪bool

Definition at line 187 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 230 of file Indexer.php.

References 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 112 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 125 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.

Parameters

array $fileInfo

Returns: ‪array

Definition at line 364 of file Indexer.php.

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

◆ updateIndexEntry()

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

Update index entry

Parameters

File $fileObject

Returns: ‪File

Definition at line 97 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 51 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 39 of file Indexer.php.

◆ $identifiedFileUids

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

protected

Definition at line 43 of file Indexer.php.

◆ $storage

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

protected

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