SilverStripe\TextExtraction\Extractor\FileTextExtractor
A decorator for File or a subclass that provides a method for extracting full-text from the file's external contents.
- Author: mstephens
Synopsis
class FileTextExtractor
{
- // members
- private static integer $priority = 50;
- protected static $sorted_extractor_classes = NULL;
- // methods
- protected static array get_extractor_classes()
- protected static FileTextExtractor get_extractor()
- public static FileTextExtractor|null for_file()
- protected static string getPathFromFile()
- public abstract boolean isAvailable()
- public abstract boolean supportsExtension()
- public abstract boolean supportsMime()
- public abstract string getContent()
Hierarchy
Uses
- SilverStripe\Core\Config\Configurable
- SilverStripe\Core\Injector\Injectable
Members
private
- $priority
—
integer
Set priority from 0-100.
protected
- $sorted_extractor_classes
—
array
Cache of extractor class names, sorted by priority
Methods
protected
- getPathFromFile() — Some text extractors (like pdftotext) may require a physical file to read from, so write the current file contents to a temp file and return its path
- get_extractor() — Get the text file extractor for the given class
- get_extractor_classes() — Gets the list of prioritised extractor classes
public
- for_file() — Given a File object, decide which extractor instance to use to handle it
- getContent() — Given a File instance, extract the contents as text.
- isAvailable() — Checks if the extractor is supported on the current environment, for example if the correct binaries or libraries are available.
- supportsExtension() — Determine if this extractor supports the given extension.
- supportsMime() — Determine if this extractor supports the given mime type.