TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
ExtractorInterface Interface Reference
Inheritance diagram for ExtractorInterface:
Extractor

Public Member Functions

 getFileTypeRestrictions ()
 
 getDriverRestrictions ()
 
 getPriority ()
 
 getExecutionPriority ()
 
 canProcess (Resource\File $file)
 
 extractMetaData (Resource\File $file, array $previousExtractedData=[])
 

Detailed Description

An Interface for MetaData extractors the FAL Indexer uses

Definition at line 22 of file ExtractorInterface.php.

Member Function Documentation

canProcess ( Resource\File  $file)

Checks if the given file can be processed by this Extractor

Parameters
Resource\File$file
Returns
bool
extractMetaData ( Resource\File  $file,
array  $previousExtractedData = [] 
)

The actual processing TASK

Should return an array with database properties for sys_file_metadata to write

Parameters
Resource\File$file
array$previousExtractedDataoptional, contains the array of already extracted data
Returns
array
getDriverRestrictions ( )

Get all supported DriverClasses

Since some extractors may only work for local files, and other extractors are especially made for grabbing data from remote.

Returns array of string with driver names of Drivers which are supported, If the driver did not register a name, it's the classname. empty array indicates no restrictions

Returns
array

Implemented in Extractor.

getExecutionPriority ( )

Returns the execution priority of the extraction Service Should be between 1 and 100, 100 means runs as first service, 1 runs at last service

Returns
int

Implemented in Extractor.

getFileTypeRestrictions ( )

Returns an array of supported file types; An empty array indicates all filetypes

Returns
array

Implemented in Extractor.

Referenced by Indexer\isFileTypeSupportedByExtractor().

getPriority ( )

Returns the data priority of the extraction Service. Defines the precedence of Data if several extractors extracted the same property.

Should be between 1 and 100, 100 is more important than 1

Returns
int

Implemented in Extractor.

Referenced by ExtractorRegistry\compareExtractorPriority().