ExternalToolConfiguration

final readonly class \TYPO3\CMS\IndexedSearch\TextExtraction\ExternalToolConfiguration

Reads the extension configuration of the external tools used to extract text from documents, and the file extensions that are excluded from indexing.

Table of Contents

Methods

__construct()  : mixed
getPdfMode()  : int
Zero: whole PDF file is indexed in one. A positive value indicates the number of pages at a time, for example "5" means 1-5,6-10,... A negative value indicates the number of groups (absolute value), for example "3" groups of 10 pages: 1-4,5-8,9-10
getToolPath()  : string|null
Absolute path of an executable, or null if the directory is not configured or the executable does not exist in that directory.
isIgnored()  : bool
File extensions which must not be indexed, as configured in the extension configuration

Methods

getPdfMode()

Zero: whole PDF file is indexed in one. A positive value indicates the number of pages at a time, for example "5" means 1-5,6-10,... A negative value indicates the number of groups (absolute value), for example "3" groups of 10 pages: 1-4,5-8,9-10

public getPdfMode() : int

Return values

int

getToolPath()

Absolute path of an executable, or null if the directory is not configured or the executable does not exist in that directory.

public getToolPath("pdfinfo"|"pdftotext"|"catdoc"|"ppthtml"|"xlhtml"|"unzip"|"unrtf" $tool) : string|null

Parameters

$tool : "pdfinfo"|"pdftotext"|"catdoc"|"ppthtml"|"xlhtml"|"unzip"|"unrtf"

Return values

string|null

isIgnored()

File extensions which must not be indexed, as configured in the extension configuration

public isIgnored(string $extension) : bool

Parameters

$extension : string

Return values

bool
On this page