LCOV Reports for PHP

Report
in package
implements Stringable

Represents a trace file, that is a coverage report.

Interfaces, Classes, Traits and Enums

Stringable

Table of Contents

$sourceFiles  : array<string|int, mixed>
$testName  : string
__construct()  : mixed
Creates a new report.
__toString()  : string
Returns a string representation of this object.
fromJson()  : self
Creates a new line data from the specified JSON object.
parse()  : self
Parses the specified coverage data in LCOV format.

Properties

$sourceFiles

public array<string|int, mixed> $sourceFiles = []

$testName

public string $testName

Methods

__construct()

Creates a new report.

public __construct(string $testName[, array<string|int, SourceFile> $sourceFiles = [] ]) : mixed
Parameters
$testName : string

The test name.

$sourceFiles : array<string|int, SourceFile> = []

The source file list.

Return values
mixed —

__toString()

Returns a string representation of this object.

public __toString() : string
Return values
string —

The string representation of this object.

fromJson()

Creates a new line data from the specified JSON object.

public static fromJson(object $json) : self
Parameters
$json : object

A JSON object representing a line data.

Return values
self —

The instance corresponding to the specified JSON object.

parse()

Parses the specified coverage data in LCOV format.

public static parse(string $coverage) : self
Parameters
$coverage : string

The coverage data.

Tags
throws
InvalidArgumentException

A parsing error occurred.

Return values
self —

The resulting coverage report.

Search results