Table of Contents
- $count : int
- Test count
- $exampleDir : string
- $excludedFiles : array<string|int, string>
- $failed : array<string|int, mixed>
- $generatedFiles : array<string|int, mixed>
- $groups : array<string|int, mixed>|null
- $ignored : array<string|int, mixed>
- $onlyFiles : array<string|int, mixed>|null
- $preserveFiles : bool
- $runTime : int|null
- $stopOn : array<string|int, mixed>
- $testExecutor : TestExecutor
- __construct() : mixed
- excludeTests() : $this
- filterByGroup() : $this
- getFailedTests() : array<string|int, string>
- getGeneratedFiles() : array<string|int, string>
- getRunTime() : int|null
- Get last run time in seconds
- getSkippedTests() : array<string|int, string>
- getTestFiles() : array<string|int, string>
- getTotalTestCount() : int
- only() : $this
- preserveOutputFiles() : $this
- printSummary() : $this
- Outputs a summary of the last test suite run
- runTests() : bool
- stopOn() : $this
- withTestExecutor() : $this
- cleanUp() : void
- shouldStopOn() : bool
Properties
$count
Test count
private int $count$exampleDir
private string $exampleDir$excludedFiles
private array<string|int,
string> $excludedFiles$failed
private array<string|int,
mixed> $failed = array()$generatedFiles
private array<string|int,
mixed> $generatedFiles =
array()$groups
private array<string|int,
mixed>|null $groups = null$ignored
private array<string|int,
mixed> $ignored = array()$onlyFiles
private array<string|int,
mixed>|null $onlyFiles = null$preserveFiles
private bool $preserveFiles =
false$runTime
private int|null $runTime = null$stopOn
private array<string|int,
mixed> $stopOn = array()$testExecutor
private
TestExecutor
$testExecutorMethods
__construct()
public __construct(mixed $exampleDir)
: mixed
Parameters
- $exampleDir : mixed
Return values
mixed —excludeTests()
public excludeTests(array<string|int,
mixed> $excluded)
: $this
Parameters
- $excluded : array<string|int, mixed>
Return values
$this —filterByGroup()
public filterByGroup(array<string|int,
mixed> $groups)
: $this
Parameters
- $groups : array<string|int, mixed>
Return values
$this —getFailedTests()
public getFailedTests()
: array<string|int,
string>
Return values
array<string|int, string> —getGeneratedFiles()
public getGeneratedFiles()
: array<string|int,
string>
Return values
array<string|int, string> —getRunTime()
Get last run time in seconds
public getRunTime()
: int|null
Return values
int|null —getSkippedTests()
public getSkippedTests()
: array<string|int,
string>
Return values
array<string|int, string> —getTestFiles()
public getTestFiles()
: array<string|int,
string>
Return values
array<string|int, string> —getTotalTestCount()
public getTotalTestCount()
: int
Return values
int —only()
public only(array<string|int,
mixed> $files)
: $this
Parameters
- $files : array<string|int, mixed>
Return values
$this —preserveOutputFiles()
public preserveOutputFiles([bool $preserve
= true
]) : $this
Parameters
- $preserve : bool = true
Return values
$this —printSummary()
Outputs a summary of the last test suite run
public printSummary()
: $this
Return values
$this —runTests()
public runTests(string $outputDir)
: bool
Parameters
- $outputDir : string
-
Path to output folder
Return values
bool —TRUE if all tests passed, FALSE otherwise
stopOn()
public stopOn(array<string|int,
string> $conditions)
: $this
Parameters
- $conditions : array<string|int, string>
Return values
$this —withTestExecutor()
public withTestExecutor(TestExecutor $testExecutor)
: $this
Parameters
- $testExecutor : TestExecutor
Return values
$this —cleanUp()
private cleanUp()
: void
Return values
void —shouldStopOn()
private shouldStopOn(string $condition)
: bool
Parameters
- $condition : string