TYPO3 CMS  TYPO3_6-2
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)
 

Protected Member Functions

 detectMissingFiles ()
 
 detectChangedFilesInStorage (array $fileIdentifierArray)
 
 processChangedAndNewFiles ()
 
 extractRequiredMetaData (File $fileObject)
 
 gatherFileInformationArray ($identifier)
 
 getFileType ($mimeType)
 
 transformFromDriverFileInfoArrayToFileObjectFormat (array $fileInfo)
 
 getFileIndexRepository ()
 
 getMetaDataRepository ()
 
 getResourceFactory ()
 
 getExtractorRegistry ()
 

Protected Attributes

 $filesToUpdate = array()
 
 $identifiedFileUids = array()
 
 $storage = NULL
 

Detailed Description

The New FAL Indexer

Definition at line 24 of file Indexer.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 44 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 55 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 144 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 125 of file Indexer.php.

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

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

◆ 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 213 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 240 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().

◆ getExtractorRegistry()

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

Returns an instance of the FileIndexRepository

Returns
ExtractorRegistry

Definition at line 347 of file Indexer.php.

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

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

◆ getFileIndexRepository()

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

Returns an instance of the FileIndexRepository

Returns
FileIndexRepository

Definition at line 320 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\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 257 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 329 of file Indexer.php.

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

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

◆ getResourceFactory()

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

Returns the ResourceFactory

Returns

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

◆ 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 173 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 82 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
integer$maximumFileCount
Returns
void

Definition at line 95 of file Indexer.php.

References TYPO3\CMS\Core\Resource\Index\Indexer\getExtractorRegistry(), TYPO3\CMS\Core\Resource\Index\Indexer\getFileIndexRepository(), TYPO3\CMS\Core\Resource\Index\Indexer\getMetaDataRepository(), 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 292 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 72 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

◆ $filesToUpdate

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

Definition at line 29 of file Indexer.php.

◆ $identifiedFileUids

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

Definition at line 34 of file Indexer.php.

◆ $storage

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

Definition at line 39 of file Indexer.php.

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