Extractor implements ExtractorInterface

Table of Contents

Interfaces

ExtractorInterface
An Interface for MetaData extractors the FAL Indexer uses

Methods

canProcess()  : bool
Checks if the given file can be processed by this Extractor
extractMetaData()  : array<string|int, mixed>
The actual processing TASK Should return an array with database properties for sys_file_metadata to write
getDriverRestrictions()  : array<string|int, mixed>
Get all supported DriverClasses empty array indicates no restrictions
getExecutionPriority()  : int
Returns the execution priority of the extraction Service
getFileTypeRestrictions()  : array<string|int, mixed>
Returns an array of supported file types
getPriority()  : int
Returns the data priority of the extraction Service

Methods

canProcess()

Checks if the given file can be processed by this Extractor

public canProcess(File $file) : bool
Parameters
$file : File
Return values
bool

extractMetaData()

The actual processing TASK Should return an array with database properties for sys_file_metadata to write

public extractMetaData(File $file[, array<string|int, mixed> $previousExtractedData = [] ]) : array<string|int, mixed>
Parameters
$file : File
$previousExtractedData : array<string|int, mixed> = []

optional, contains the array of already extracted data

Return values
array<string|int, mixed>

getDriverRestrictions()

Get all supported DriverClasses empty array indicates no restrictions

public getDriverRestrictions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getExecutionPriority()

Returns the execution priority of the extraction Service

public getExecutionPriority() : int
Return values
int

getFileTypeRestrictions()

Returns an array of supported file types

public getFileTypeRestrictions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPriority()

Returns the data priority of the extraction Service

public getPriority() : int
Return values
int

        
On this page

Search results