Documentation

Metadata
in package

AbstractYes
Tags
psalm-immutable
no-named-arguments

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

Table of Contents

Constants

CLASS_LEVEL  = 0
METHOD_LEVEL  = 1

Properties

$level  : int

Methods

after()  : After
afterClass()  : AfterClass
backupGlobalsOnClass()  : BackupGlobals
backupGlobalsOnMethod()  : BackupGlobals
backupStaticPropertiesOnClass()  : BackupStaticProperties
backupStaticPropertiesOnMethod()  : BackupStaticProperties
before()  : Before
beforeClass()  : BeforeClass
coversClass()  : CoversClass
coversDefaultClass()  : CoversDefaultClass
coversFunction()  : CoversFunction
coversNothingOnClass()  : CoversNothing
coversNothingOnMethod()  : CoversNothing
coversOnClass()  : Covers
coversOnMethod()  : Covers
dataProvider()  : DataProvider
dependsOnClass()  : DependsOnClass
dependsOnMethod()  : DependsOnMethod
doesNotPerformAssertionsOnClass()  : DoesNotPerformAssertions
doesNotPerformAssertionsOnMethod()  : DoesNotPerformAssertions
excludeGlobalVariableFromBackupOnClass()  : ExcludeGlobalVariableFromBackup
excludeGlobalVariableFromBackupOnMethod()  : ExcludeGlobalVariableFromBackup
excludeStaticPropertyFromBackupOnClass()  : ExcludeStaticPropertyFromBackup
excludeStaticPropertyFromBackupOnMethod()  : ExcludeStaticPropertyFromBackup
groupOnClass()  : Group
groupOnMethod()  : Group
ignoreClassForCodeCoverage()  : IgnoreClassForCodeCoverage
ignoreDeprecationsOnClass()  : IgnoreDeprecations
ignoreDeprecationsOnMethod()  : IgnoreDeprecations
ignoreFunctionForCodeCoverage()  : IgnoreFunctionForCodeCoverage
ignoreMethodForCodeCoverage()  : IgnoreMethodForCodeCoverage
isAfter()  : bool
isAfterClass()  : bool
isBackupGlobals()  : bool
isBackupStaticProperties()  : bool
isBefore()  : bool
isBeforeClass()  : bool
isClassLevel()  : bool
isCovers()  : bool
isCoversClass()  : bool
isCoversDefaultClass()  : bool
isCoversFunction()  : bool
isCoversNothing()  : bool
isDataProvider()  : bool
isDependsOnClass()  : bool
isDependsOnMethod()  : bool
isDoesNotPerformAssertions()  : bool
isExcludeGlobalVariableFromBackup()  : bool
isExcludeStaticPropertyFromBackup()  : bool
isGroup()  : bool
isIgnoreClassForCodeCoverage()  : bool
isIgnoreDeprecations()  : bool
isIgnoreFunctionForCodeCoverage()  : bool
isIgnoreMethodForCodeCoverage()  : bool
isMethodLevel()  : bool
isPostCondition()  : bool
isPreCondition()  : bool
isPreserveGlobalState()  : bool
isRequiresFunction()  : bool
isRequiresMethod()  : bool
isRequiresOperatingSystem()  : bool
isRequiresOperatingSystemFamily()  : bool
isRequiresPhp()  : bool
isRequiresPhpExtension()  : bool
isRequiresPhpunit()  : bool
isRequiresSetting()  : bool
isRunClassInSeparateProcess()  : bool
isRunInSeparateProcess()  : bool
isRunTestsInSeparateProcesses()  : bool
isTest()  : bool
isTestDox()  : bool
isTestWith()  : bool
isUses()  : bool
isUsesClass()  : bool
isUsesDefaultClass()  : bool
isUsesFunction()  : bool
isWithoutErrorHandler()  : bool
postCondition()  : PostCondition
preCondition()  : PreCondition
preserveGlobalStateOnClass()  : PreserveGlobalState
preserveGlobalStateOnMethod()  : PreserveGlobalState
requiresFunctionOnClass()  : RequiresFunction
requiresFunctionOnMethod()  : RequiresFunction
requiresMethodOnClass()  : RequiresMethod
requiresMethodOnMethod()  : RequiresMethod
requiresOperatingSystemFamilyOnClass()  : RequiresOperatingSystemFamily
requiresOperatingSystemFamilyOnMethod()  : RequiresOperatingSystemFamily
requiresOperatingSystemOnClass()  : RequiresOperatingSystem
requiresOperatingSystemOnMethod()  : RequiresOperatingSystem
requiresPhpExtensionOnClass()  : RequiresPhpExtension
requiresPhpExtensionOnMethod()  : RequiresPhpExtension
requiresPhpOnClass()  : RequiresPhp
requiresPhpOnMethod()  : RequiresPhp
requiresPhpunitOnClass()  : RequiresPhpunit
requiresPhpunitOnMethod()  : RequiresPhpunit
requiresSettingOnClass()  : RequiresSetting
requiresSettingOnMethod()  : RequiresSetting
runClassInSeparateProcess()  : RunClassInSeparateProcess
runInSeparateProcess()  : RunInSeparateProcess
runTestsInSeparateProcesses()  : RunTestsInSeparateProcesses
test()  : Test
testDoxOnClass()  : TestDox
testDoxOnMethod()  : TestDox
testWith()  : TestWith
usesClass()  : UsesClass
usesDefaultClass()  : UsesDefaultClass
usesFunction()  : UsesFunction
usesOnClass()  : Uses
usesOnMethod()  : Uses
withoutErrorHandler()  : WithoutErrorHandler
__construct()  : mixed

Constants

CLASS_LEVEL

private mixed CLASS_LEVEL = 0

METHOD_LEVEL

private mixed METHOD_LEVEL = 1

Properties

$level read-only

private int $level
Tags
psalm-var

0|1

Methods

coversClass()

public static coversClass(string $className) : CoversClass
Parameters
$className : string
Tags
psalm-param

class-string $className

Return values
CoversClass

coversFunction()

public static coversFunction(string $functionName) : CoversFunction
Parameters
$functionName : string
Tags
psalm-param

non-empty-string $functionName

Return values
CoversFunction

coversOnClass()

public static coversOnClass(string $target) : Covers
Parameters
$target : string
Tags
psalm-param

non-empty-string $target

Return values
Covers

coversOnMethod()

public static coversOnMethod(string $target) : Covers
Parameters
$target : string
Tags
psalm-param

non-empty-string $target

Return values
Covers

dataProvider()

public static dataProvider(string $className, string $methodName) : DataProvider
Parameters
$className : string
$methodName : string
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $methodName

Return values
DataProvider

dependsOnClass()

public static dependsOnClass(string $className, bool $deepClone, bool $shallowClone) : DependsOnClass
Parameters
$className : string
$deepClone : bool
$shallowClone : bool
Tags
psalm-param

class-string $className

Return values
DependsOnClass

dependsOnMethod()

public static dependsOnMethod(string $className, string $methodName, bool $deepClone, bool $shallowClone) : DependsOnMethod
Parameters
$className : string
$methodName : string
$deepClone : bool
$shallowClone : bool
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $methodName

Return values
DependsOnMethod

excludeStaticPropertyFromBackupOnClass()

public static excludeStaticPropertyFromBackupOnClass(string $className, string $propertyName) : ExcludeStaticPropertyFromBackup
Parameters
$className : string
$propertyName : string
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $propertyName

Return values
ExcludeStaticPropertyFromBackup

excludeStaticPropertyFromBackupOnMethod()

public static excludeStaticPropertyFromBackupOnMethod(string $className, string $propertyName) : ExcludeStaticPropertyFromBackup
Parameters
$className : string
$propertyName : string
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $propertyName

Return values
ExcludeStaticPropertyFromBackup

groupOnClass()

public static groupOnClass(string $groupName) : Group
Parameters
$groupName : string
Tags
psalm-param

non-empty-string $groupName

Return values
Group

groupOnMethod()

public static groupOnMethod(string $groupName) : Group
Parameters
$groupName : string
Tags
psalm-param

non-empty-string $groupName

Return values
Group

ignoreMethodForCodeCoverage()

public static ignoreMethodForCodeCoverage(string $className, string $methodName) : IgnoreMethodForCodeCoverage
Parameters
$className : string
$methodName : string
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $methodName

Return values
IgnoreMethodForCodeCoverage

isAfter()

public isAfter() : bool
Tags
psalm-assert-if-true

After $this

Return values
bool

isAfterClass()

public isAfterClass() : bool
Tags
psalm-assert-if-true

AfterClass $this

Return values
bool

isBackupGlobals()

public isBackupGlobals() : bool
Tags
psalm-assert-if-true

BackupGlobals $this

Return values
bool

isBackupStaticProperties()

public isBackupStaticProperties() : bool
Tags
psalm-assert-if-true

BackupStaticProperties $this

Return values
bool

isBefore()

public isBefore() : bool
Tags
psalm-assert-if-true

Before $this

Return values
bool

isBeforeClass()

public isBeforeClass() : bool
Tags
psalm-assert-if-true

BeforeClass $this

Return values
bool

isClassLevel()

public isClassLevel() : bool
Return values
bool

isCovers()

public isCovers() : bool
Tags
psalm-assert-if-true

Covers $this

Return values
bool

isCoversClass()

public isCoversClass() : bool
Tags
psalm-assert-if-true

CoversClass $this

Return values
bool

isCoversDefaultClass()

public isCoversDefaultClass() : bool
Tags
psalm-assert-if-true

CoversDefaultClass $this

Return values
bool

isCoversFunction()

public isCoversFunction() : bool
Tags
psalm-assert-if-true

CoversFunction $this

Return values
bool

isCoversNothing()

public isCoversNothing() : bool
Tags
psalm-assert-if-true

CoversNothing $this

Return values
bool

isDataProvider()

public isDataProvider() : bool
Tags
psalm-assert-if-true

DataProvider $this

Return values
bool

isDependsOnClass()

public isDependsOnClass() : bool
Tags
psalm-assert-if-true

DependsOnClass $this

Return values
bool

isDependsOnMethod()

public isDependsOnMethod() : bool
Tags
psalm-assert-if-true

DependsOnMethod $this

Return values
bool

isDoesNotPerformAssertions()

public isDoesNotPerformAssertions() : bool
Tags
psalm-assert-if-true

DoesNotPerformAssertions $this

Return values
bool

isExcludeGlobalVariableFromBackup()

public isExcludeGlobalVariableFromBackup() : bool
Tags
psalm-assert-if-true

ExcludeGlobalVariableFromBackup $this

Return values
bool

isExcludeStaticPropertyFromBackup()

public isExcludeStaticPropertyFromBackup() : bool
Tags
psalm-assert-if-true

ExcludeStaticPropertyFromBackup $this

Return values
bool

isGroup()

public isGroup() : bool
Tags
psalm-assert-if-true

Group $this

Return values
bool

isIgnoreClassForCodeCoverage()

public isIgnoreClassForCodeCoverage() : bool
Tags
psalm-assert-if-true

IgnoreClassForCodeCoverage $this

Return values
bool

isIgnoreDeprecations()

public isIgnoreDeprecations() : bool
Tags
psalm-assert-if-true

IgnoreDeprecations $this

Return values
bool

isIgnoreFunctionForCodeCoverage()

public isIgnoreFunctionForCodeCoverage() : bool
Tags
psalm-assert-if-true

IgnoreFunctionForCodeCoverage $this

Return values
bool

isIgnoreMethodForCodeCoverage()

public isIgnoreMethodForCodeCoverage() : bool
Tags
psalm-assert-if-true

IgnoreMethodForCodeCoverage $this

Return values
bool

isMethodLevel()

public isMethodLevel() : bool
Return values
bool

isPostCondition()

public isPostCondition() : bool
Tags
psalm-assert-if-true

PostCondition $this

Return values
bool

isPreCondition()

public isPreCondition() : bool
Tags
psalm-assert-if-true

PreCondition $this

Return values
bool

isPreserveGlobalState()

public isPreserveGlobalState() : bool
Tags
psalm-assert-if-true

PreserveGlobalState $this

Return values
bool

isRequiresFunction()

public isRequiresFunction() : bool
Tags
psalm-assert-if-true

RequiresFunction $this

Return values
bool

isRequiresMethod()

public isRequiresMethod() : bool
Tags
psalm-assert-if-true

RequiresMethod $this

Return values
bool

isRequiresOperatingSystem()

public isRequiresOperatingSystem() : bool
Tags
psalm-assert-if-true

RequiresOperatingSystem $this

Return values
bool

isRequiresOperatingSystemFamily()

public isRequiresOperatingSystemFamily() : bool
Tags
psalm-assert-if-true

RequiresOperatingSystemFamily $this

Return values
bool

isRequiresPhp()

public isRequiresPhp() : bool
Tags
psalm-assert-if-true

RequiresPhp $this

Return values
bool

isRequiresPhpExtension()

public isRequiresPhpExtension() : bool
Tags
psalm-assert-if-true

RequiresPhpExtension $this

Return values
bool

isRequiresPhpunit()

public isRequiresPhpunit() : bool
Tags
psalm-assert-if-true

RequiresPhpunit $this

Return values
bool

isRequiresSetting()

public isRequiresSetting() : bool
Tags
psalm-assert-if-true

RequiresSetting $this

Return values
bool

isRunClassInSeparateProcess()

public isRunClassInSeparateProcess() : bool
Tags
psalm-assert-if-true

RunClassInSeparateProcess $this

Return values
bool

isRunInSeparateProcess()

public isRunInSeparateProcess() : bool
Tags
psalm-assert-if-true

RunInSeparateProcess $this

Return values
bool

isRunTestsInSeparateProcesses()

public isRunTestsInSeparateProcesses() : bool
Tags
psalm-assert-if-true

RunTestsInSeparateProcesses $this

Return values
bool

isTest()

public isTest() : bool
Tags
psalm-assert-if-true

Test $this

Return values
bool

isTestDox()

public isTestDox() : bool
Tags
psalm-assert-if-true

TestDox $this

Return values
bool

isTestWith()

public isTestWith() : bool
Tags
psalm-assert-if-true

TestWith $this

Return values
bool

isUses()

public isUses() : bool
Tags
psalm-assert-if-true

Uses $this

Return values
bool

isUsesClass()

public isUsesClass() : bool
Tags
psalm-assert-if-true

UsesClass $this

Return values
bool

isUsesDefaultClass()

public isUsesDefaultClass() : bool
Tags
psalm-assert-if-true

UsesDefaultClass $this

Return values
bool

isUsesFunction()

public isUsesFunction() : bool
Tags
psalm-assert-if-true

UsesFunction $this

Return values
bool

isWithoutErrorHandler()

public isWithoutErrorHandler() : bool
Tags
psalm-assert-if-true

WithoutErrorHandler $this

Return values
bool

requiresFunctionOnClass()

public static requiresFunctionOnClass(string $functionName) : RequiresFunction
Parameters
$functionName : string
Tags
psalm-param

non-empty-string $functionName

Return values
RequiresFunction

requiresFunctionOnMethod()

public static requiresFunctionOnMethod(string $functionName) : RequiresFunction
Parameters
$functionName : string
Tags
psalm-param

non-empty-string $functionName

Return values
RequiresFunction

requiresMethodOnClass()

public static requiresMethodOnClass(string $className, string $methodName) : RequiresMethod
Parameters
$className : string
$methodName : string
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $methodName

Return values
RequiresMethod

requiresMethodOnMethod()

public static requiresMethodOnMethod(string $className, string $methodName) : RequiresMethod
Parameters
$className : string
$methodName : string
Tags
psalm-param

class-string $className

psalm-param

non-empty-string $methodName

Return values
RequiresMethod

requiresSettingOnClass()

public static requiresSettingOnClass(string $setting, string $value) : RequiresSetting
Parameters
$setting : string
$value : string
Tags
psalm-param

non-empty-string $setting

psalm-param

non-empty-string $value

Return values
RequiresSetting

requiresSettingOnMethod()

public static requiresSettingOnMethod(string $setting, string $value) : RequiresSetting
Parameters
$setting : string
$value : string
Tags
psalm-param

non-empty-string $setting

psalm-param

non-empty-string $value

Return values
RequiresSetting

testDoxOnClass()

public static testDoxOnClass(string $text) : TestDox
Parameters
$text : string
Tags
psalm-param

non-empty-string $text

Return values
TestDox

testDoxOnMethod()

public static testDoxOnMethod(string $text) : TestDox
Parameters
$text : string
Tags
psalm-param

non-empty-string $text

Return values
TestDox

testWith()

public static testWith(array<string|int, mixed> $data) : TestWith
Parameters
$data : array<string|int, mixed>
Return values
TestWith

usesClass()

public static usesClass(string $className) : UsesClass
Parameters
$className : string
Tags
psalm-param

class-string $className

Return values
UsesClass

usesFunction()

public static usesFunction(string $functionName) : UsesFunction
Parameters
$functionName : string
Tags
psalm-param

non-empty-string $functionName

Return values
UsesFunction

usesOnClass()

public static usesOnClass(string $target) : Uses
Parameters
$target : string
Tags
psalm-param

non-empty-string $target

Return values
Uses

usesOnMethod()

public static usesOnMethod(string $target) : Uses
Parameters
$target : string
Tags
psalm-param

non-empty-string $target

Return values
Uses

__construct()

protected __construct(int $level) : mixed
Parameters
$level : int
Tags
psalm-param

0|1 $level


        
On this page

Search results