TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Resource\Index\Indexer Class Reference

Public Member Functions

 __construct (ResourceStorage $storage)
 
 createIndexEntry ($identifier)
 
 updateIndexEntry (File $fileObject)
 
 processChangesInStorages ()
 
 runMetaDataExtraction ($maximumFileCount=-1)
 
 extractMetaData (File $fileObject)
 

Protected Member Functions

 getExtractionServices ()
 
 detectMissingFiles ()
 
 isFileTypeSupportedByExtractor (File $file, ExtractorInterface $extractor)
 
 detectChangedFilesInStorage (array $fileIdentifierArray)
 
 processChangedAndNewFiles ()
 
 extractRequiredMetaData (File $fileObject)
 
 gatherFileInformationArray ($identifier)
 
 getFileType ($mimeType)
 
 transformFromDriverFileInfoArrayToFileObjectFormat (array $fileInfo)
 
 getFileIndexRepository ()
 
 getMetaDataRepository ()
 
 getResourceFactory ()
 
 getExtractorRegistry ()
 

Protected Attributes

 $filesToUpdate = []
 
 $identifiedFileUids = []
 
 $storage = null
 
 $extractionServices = null
 

Detailed Description

The New FAL Indexer

Definition at line 27 of file Indexer.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 52 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
Returns
File
Exceptions

Definition at line 64 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\extractRequiredMetaData(), TYPO3\CMS\Core\Resource\Index\Indexer\gatherFileInformationArray(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), and TYPO3\CMS\Core\Resource\Index\Indexer\getResourceFactory().

Referenced by 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
Returns
void

Definition at line 214 of file Indexer.php.

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

References TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository().

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

References TYPO3\CMS\Core\Resource\File\_getMetaData(), TYPO3\CMS\Core\Resource\File\_updateMetaDataProperties(), TYPO3\CMS\Core\Resource\Index\Indexer\getExtractionServices(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\Index\Indexer\getMetaDataRepository(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), and TYPO3\CMS\Core\Resource\Index\Indexer\isFileTypeSupportedByExtractor().

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

◆ 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

Parameters
File$fileObject

Definition at line 285 of file Indexer.php.

References TYPO3\CMS\Core\Resource\File\_updateMetaDataProperties(), TYPO3\CMS\Core\Resource\AbstractFile\FILETYPE_IMAGE, TYPO3\CMS\Core\Resource\AbstractFile\getForLocalProcessing(), TYPO3\CMS\Core\Resource\Index\Indexer\getMetaDataRepository(), TYPO3\CMS\Core\Resource\AbstractFile\getType(), TYPO3\CMS\Core\Resource\AbstractFile\getUid(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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
Returns
array

Definition at line 313 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\getFileType(), TYPO3\CMS\Core\Utility\PathUtility\pathinfo(), 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().

◆ getExtractionServices()

TYPO3\CMS\Core\Resource\Index\Indexer::getExtractionServices ( )
protected

Get available extraction services

Returns
ExtractorInterface[]

Definition at line 165 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\$extractionServices, and TYPO3\CMS\Core\Resource\Index\Indexer\getExtractorRegistry().

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

◆ getExtractorRegistry()

TYPO3\CMS\Core\Resource\Index\Indexer::getExtractorRegistry ( )
protected

Returns an instance of the FileIndexRepository

Returns
ExtractorRegistry

Definition at line 425 of file Indexer.php.

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

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

◆ getFileIndexRepository()

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

Returns an instance of the FileIndexRepository

Returns
FileIndexRepository

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

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

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

Returns an instance of the FileIndexRepository

Returns
MetaDataRepository

Definition at line 405 of file Indexer.php.

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

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

◆ getResourceFactory()

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

Returns the ResourceFactory

Returns

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

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

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

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

◆ processChangedAndNewFiles()

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

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

Returns
void

Definition at line 244 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\createIndexEntry(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\Index\Indexer\getResourceFactory(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

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

◆ processChangesInStorages()

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

Definition at line 93 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
Returns
void

Definition at line 107 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), and TYPO3\CMS\Core\Resource\Index\Indexer\getResourceFactory().

◆ transformFromDriverFileInfoArrayToFileObjectFormat()

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 367 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

Parameters
File$fileObject
Returns
void

Definition at line 82 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\extractRequiredMetaData(), TYPO3\CMS\Core\Resource\Index\Indexer\gatherFileInformationArray(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\AbstractFile\getIdentifier(), and TYPO3\CMS\Core\Resource\File\updateProperties().

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

Member Data Documentation

◆ $extractionServices

TYPO3\CMS\Core\Resource\Index\Indexer::$extractionServices = null
protected

Definition at line 47 of file Indexer.php.

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

◆ $filesToUpdate

TYPO3\CMS\Core\Resource\Index\Indexer::$filesToUpdate = []
protected

Definition at line 32 of file Indexer.php.

◆ $identifiedFileUids

TYPO3\CMS\Core\Resource\Index\Indexer::$identifiedFileUids = []
protected

Definition at line 37 of file Indexer.php.

◆ $storage

TYPO3\CMS\Core\Resource\Index\Indexer::$storage = null
protected

Definition at line 42 of file Indexer.php.

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