ScanResult

Read onlyYes
FinalYes

The outcome of scanning one file.

A file that could not be parsed yields a result carrying the parser message and no matches, so that scanning a whole extension is not aborted by a single unparsable file.

Internal

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Table of Contents

Methods

__construct()  : mixed
getEffectiveCodeLines()  : int
getFile()  : string
getIgnoredLines()  : int
getMatches()  : array<int, ScanMatch>
getParseError()  : string|null
isFileIgnored()  : bool

Methods

__construct()

public __construct(string $file, array<int, ScanMatch> $matches, string|null $parseError, bool $isFileIgnored, int $effectiveCodeLines, int $ignoredLines) : mixed
Parameters
$file : string
$matches : array<int, ScanMatch>
$parseError : string|null
$isFileIgnored : bool
$effectiveCodeLines : int
$ignoredLines : int

getEffectiveCodeLines()

public getEffectiveCodeLines() : int
Return values
int

getFile()

public getFile() : string
Return values
string

getIgnoredLines()

public getIgnoredLines() : int
Return values
int

getParseError()

public getParseError() : string|null
Return values
string|null

isFileIgnored()

public isFileIgnored() : bool
Return values
bool
On this page

Search results