Documentation

Source
in package

Read onlyYes
FinalYes
Tags
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

immutable

Table of Contents

Properties

$baseline  : non-empty-string
$deprecationTriggers  : array{functions: list, methods: list}
$excludeDirectories  : FilterDirectoryCollection
$excludeFiles  : FileCollection
$identifyIssueTrigger  : bool
$ignoreBaseline  : bool
$ignoreDirectDeprecations  : bool
$ignoreIndirectDeprecations  : bool
$ignoreSelfDeprecations  : bool
$ignoreSuppressionOfDeprecations  : bool
$ignoreSuppressionOfErrors  : bool
$ignoreSuppressionOfNotices  : bool
$ignoreSuppressionOfPhpDeprecations  : bool
$ignoreSuppressionOfPhpNotices  : bool
$ignoreSuppressionOfPhpWarnings  : bool
$ignoreSuppressionOfWarnings  : bool
$includeDirectories  : FilterDirectoryCollection
$includeFiles  : FileCollection
$restrictDeprecations  : bool
$restrictNotices  : bool
$restrictWarnings  : bool

Methods

__construct()  : mixed
baseline()  : non-empty-string
deprecationTriggers()  : array{functions: list, methods: list}
excludeDirectories()  : FilterDirectoryCollection
excludeFiles()  : FileCollection
hasBaseline()  : bool
identifyIssueTrigger()  : bool
ignoreDirectDeprecations()  : bool
ignoreIndirectDeprecations()  : bool
ignoreSelfDeprecations()  : bool
ignoreSuppressionOfDeprecations()  : bool
ignoreSuppressionOfErrors()  : bool
ignoreSuppressionOfNotices()  : bool
ignoreSuppressionOfPhpDeprecations()  : bool
ignoreSuppressionOfPhpNotices()  : bool
ignoreSuppressionOfPhpWarnings()  : bool
ignoreSuppressionOfWarnings()  : bool
includeDirectories()  : FilterDirectoryCollection
includeFiles()  : FileCollection
notEmpty()  : bool
restrictDeprecations()  : bool
restrictNotices()  : bool
restrictWarnings()  : bool
useBaseline()  : bool

Properties

$baseline

private non-empty-string $baseline

$deprecationTriggers

private array{functions: list, methods: list} $deprecationTriggers

$identifyIssueTrigger

private bool $identifyIssueTrigger

$ignoreBaseline

private bool $ignoreBaseline

$ignoreDirectDeprecations

private bool $ignoreDirectDeprecations

$ignoreIndirectDeprecations

private bool $ignoreIndirectDeprecations

$ignoreSelfDeprecations

private bool $ignoreSelfDeprecations

$ignoreSuppressionOfDeprecations

private bool $ignoreSuppressionOfDeprecations

$ignoreSuppressionOfErrors

private bool $ignoreSuppressionOfErrors

$ignoreSuppressionOfNotices

private bool $ignoreSuppressionOfNotices

$ignoreSuppressionOfPhpDeprecations

private bool $ignoreSuppressionOfPhpDeprecations

$ignoreSuppressionOfPhpNotices

private bool $ignoreSuppressionOfPhpNotices

$ignoreSuppressionOfPhpWarnings

private bool $ignoreSuppressionOfPhpWarnings

$ignoreSuppressionOfWarnings

private bool $ignoreSuppressionOfWarnings

$restrictDeprecations

private bool $restrictDeprecations

$restrictNotices

private bool $restrictNotices

$restrictWarnings

private bool $restrictWarnings

Methods

__construct()

public __construct(non-empty-string|null $baseline, bool $ignoreBaseline, FilterDirectoryCollection $includeDirectories, FileCollection $includeFiles, FilterDirectoryCollection $excludeDirectories, FileCollection $excludeFiles, bool $restrictDeprecations, bool $restrictNotices, bool $restrictWarnings, bool $ignoreSuppressionOfDeprecations, bool $ignoreSuppressionOfPhpDeprecations, bool $ignoreSuppressionOfErrors, bool $ignoreSuppressionOfNotices, bool $ignoreSuppressionOfPhpNotices, bool $ignoreSuppressionOfWarnings, bool $ignoreSuppressionOfPhpWarnings, array{functions: list, methods: list} $deprecationTriggers, bool $ignoreSelfDeprecations, bool $ignoreDirectDeprecations, bool $ignoreIndirectDeprecations, bool $identifyIssueTrigger) : mixed
Parameters
$baseline : non-empty-string|null
$ignoreBaseline : bool
$includeDirectories : FilterDirectoryCollection
$includeFiles : FileCollection
$excludeDirectories : FilterDirectoryCollection
$excludeFiles : FileCollection
$restrictDeprecations : bool
$restrictNotices : bool
$restrictWarnings : bool
$ignoreSuppressionOfDeprecations : bool
$ignoreSuppressionOfPhpDeprecations : bool
$ignoreSuppressionOfErrors : bool
$ignoreSuppressionOfNotices : bool
$ignoreSuppressionOfPhpNotices : bool
$ignoreSuppressionOfWarnings : bool
$ignoreSuppressionOfPhpWarnings : bool
$deprecationTriggers : array{functions: list, methods: list}
$ignoreSelfDeprecations : bool
$ignoreDirectDeprecations : bool
$ignoreIndirectDeprecations : bool
$identifyIssueTrigger : bool

baseline()

public baseline() : non-empty-string
Tags
throws
NoBaselineException
Return values
non-empty-string

deprecationTriggers()

public deprecationTriggers() : array{functions: list, methods: list}
Return values
array{functions: list, methods: list}

hasBaseline()

public hasBaseline() : bool
Tags
phpstan-assert-if-true

!null $this->baseline

Return values
bool

identifyIssueTrigger()

public identifyIssueTrigger() : bool
Return values
bool

ignoreDirectDeprecations()

public ignoreDirectDeprecations() : bool
Return values
bool

ignoreIndirectDeprecations()

public ignoreIndirectDeprecations() : bool
Return values
bool

ignoreSelfDeprecations()

public ignoreSelfDeprecations() : bool
Return values
bool

ignoreSuppressionOfDeprecations()

public ignoreSuppressionOfDeprecations() : bool
Return values
bool

ignoreSuppressionOfErrors()

public ignoreSuppressionOfErrors() : bool
Return values
bool

ignoreSuppressionOfNotices()

public ignoreSuppressionOfNotices() : bool
Return values
bool

ignoreSuppressionOfPhpDeprecations()

public ignoreSuppressionOfPhpDeprecations() : bool
Return values
bool

ignoreSuppressionOfPhpNotices()

public ignoreSuppressionOfPhpNotices() : bool
Return values
bool

ignoreSuppressionOfPhpWarnings()

public ignoreSuppressionOfPhpWarnings() : bool
Return values
bool

ignoreSuppressionOfWarnings()

public ignoreSuppressionOfWarnings() : bool
Return values
bool

notEmpty()

public notEmpty() : bool
Return values
bool

restrictDeprecations()

public restrictDeprecations() : bool
Return values
bool

restrictNotices()

public restrictNotices() : bool
Return values
bool

restrictWarnings()

public restrictWarnings() : bool
Return values
bool

useBaseline()

public useBaseline() : bool
Tags
phpstan-assert-if-true

!null $this->baseline

Return values
bool
On this page

Search results