TYPO3\CMS\Core\Resource\TextExtraction\TextExtractorInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\TextExtraction\TextExtractorInterface:

Public Member Functions
bool	canExtractText (FileInterface $file)
string	extractText (FileInterface $file)

Detailed Description

An interface for text extractors

Definition at line 23 of file TextExtractorInterface.php.

Member Function Documentation

canExtractText()

bool TYPO3\CMS\Core\Resource\TextExtraction\TextExtractorInterface::canExtractText

(

FileInterface

$file

)

Checks if the given file can be read by this extractor

Returns

‪bool

Implemented in TYPO3\CMS\Core\Resource\TextExtraction\PlainTextExtractor.

extractText()

string TYPO3\CMS\Core\Resource\TextExtraction\TextExtractorInterface::extractText

(

FileInterface

$file

)

The actual text extraction.

Should return a string of the file's content

Parameters

FileInterface

$file

Returns

‪string

Implemented in TYPO3\CMS\Core\Resource\TextExtraction\PlainTextExtractor.