Documentation

RequiresSetting extends Metadata
in package

Read onlyYes
FinalYes
Tags
immutable
no-named-arguments

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

Table of Contents

Properties

$setting  : non-empty-string
$value  : non-empty-string

Methods

after()  : After
afterClass()  : AfterClass
backupGlobalsOnClass()  : BackupGlobals
backupGlobalsOnMethod()  : BackupGlobals
backupStaticPropertiesOnClass()  : BackupStaticProperties
backupStaticPropertiesOnMethod()  : BackupStaticProperties
before()  : Before
beforeClass()  : BeforeClass
coversClass()  : CoversClass
coversDefaultClass()  : CoversDefaultClass
coversFunction()  : CoversFunction
coversMethod()  : CoversMethod
coversNothingOnClass()  : CoversNothing
coversNothingOnMethod()  : CoversNothing
coversOnClass()  : Covers
coversOnMethod()  : Covers
coversTrait()  : CoversTrait
dataProvider()  : DataProvider
dependsOnClass()  : DependsOnClass
dependsOnMethod()  : DependsOnMethod
disableReturnValueGenerationForTestDoubles()  : DisableReturnValueGenerationForTestDoubles
doesNotPerformAssertionsOnClass()  : DoesNotPerformAssertions
doesNotPerformAssertionsOnMethod()  : DoesNotPerformAssertions
excludeGlobalVariableFromBackupOnClass()  : ExcludeGlobalVariableFromBackup
excludeGlobalVariableFromBackupOnMethod()  : ExcludeGlobalVariableFromBackup
excludeStaticPropertyFromBackupOnClass()  : ExcludeStaticPropertyFromBackup
excludeStaticPropertyFromBackupOnMethod()  : ExcludeStaticPropertyFromBackup
groupOnClass()  : Group
groupOnMethod()  : Group
ignoreDeprecationsOnClass()  : IgnoreDeprecations
ignoreDeprecationsOnMethod()  : IgnoreDeprecations
isAfter()  : bool
isAfterClass()  : bool
isBackupGlobals()  : bool
isBackupStaticProperties()  : bool
isBefore()  : bool
isBeforeClass()  : bool
isClassLevel()  : bool
isCovers()  : bool
isCoversClass()  : bool
isCoversDefaultClass()  : bool
isCoversFunction()  : bool
isCoversMethod()  : bool
isCoversNothing()  : bool
isCoversTrait()  : bool
isDataProvider()  : bool
isDependsOnClass()  : bool
isDependsOnMethod()  : bool
isDisableReturnValueGenerationForTestDoubles()  : bool
isDoesNotPerformAssertions()  : bool
isExcludeGlobalVariableFromBackup()  : bool
isExcludeStaticPropertyFromBackup()  : bool
isGroup()  : bool
isIgnoreDeprecations()  : bool
isMethodLevel()  : bool
isPostCondition()  : bool
isPreCondition()  : bool
isPreserveGlobalState()  : bool
isRequiresFunction()  : bool
isRequiresMethod()  : bool
isRequiresOperatingSystem()  : bool
isRequiresOperatingSystemFamily()  : bool
isRequiresPhp()  : bool
isRequiresPhpExtension()  : bool
isRequiresPhpunit()  : bool
isRequiresPhpunitExtension()  : bool
isRequiresSetting()  : true
isRunClassInSeparateProcess()  : bool
isRunInSeparateProcess()  : bool
isRunTestsInSeparateProcesses()  : bool
isTest()  : bool
isTestDox()  : bool
isTestWith()  : bool
isUses()  : bool
isUsesClass()  : bool
isUsesDefaultClass()  : bool
isUsesFunction()  : bool
isUsesMethod()  : bool
isUsesTrait()  : 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
requiresPhpunitExtensionOnClass()  : RequiresPhpunitExtension
requiresPhpunitExtensionOnMethod()  : RequiresPhpunitExtension
requiresPhpunitOnClass()  : RequiresPhpunit
requiresPhpunitOnMethod()  : RequiresPhpunit
requiresSettingOnClass()  : RequiresSetting
requiresSettingOnMethod()  : RequiresSetting
runClassInSeparateProcess()  : RunClassInSeparateProcess
runInSeparateProcess()  : RunInSeparateProcess
runTestsInSeparateProcesses()  : RunTestsInSeparateProcesses
setting()  : non-empty-string
test()  : Test
testDoxOnClass()  : TestDox
testDoxOnMethod()  : TestDox
testWith()  : TestWith
usesClass()  : UsesClass
usesDefaultClass()  : UsesDefaultClass
usesFunction()  : UsesFunction
usesMethod()  : UsesMethod
usesOnClass()  : Uses
usesOnMethod()  : Uses
usesTrait()  : UsesTrait
value()  : non-empty-string
withoutErrorHandler()  : WithoutErrorHandler
__construct()  : mixed

Properties

Methods

after()

public static after(int $priority) : After
Parameters
$priority : int
Return values
After

before()

public static before(int $priority) : Before
Parameters
$priority : int
Return values
Before

coversMethod()

public static coversMethod(class-string $className, non-empty-string $methodName) : CoversMethod
Parameters
$className : class-string
$methodName : non-empty-string
Return values
CoversMethod

coversOnClass()

public static coversOnClass(non-empty-string $target) : Covers
Parameters
$target : non-empty-string
Return values
Covers

coversOnMethod()

public static coversOnMethod(non-empty-string $target) : Covers
Parameters
$target : non-empty-string
Return values
Covers

dataProvider()

public static dataProvider(class-string $className, non-empty-string $methodName) : DataProvider
Parameters
$className : class-string
$methodName : non-empty-string
Return values
DataProvider

dependsOnClass()

public static dependsOnClass(class-string $className, bool $deepClone, bool $shallowClone) : DependsOnClass
Parameters
$className : class-string
$deepClone : bool
$shallowClone : bool
Return values
DependsOnClass

dependsOnMethod()

public static dependsOnMethod(class-string $className, non-empty-string $methodName, bool $deepClone, bool $shallowClone) : DependsOnMethod
Parameters
$className : class-string
$methodName : non-empty-string
$deepClone : bool
$shallowClone : bool
Return values
DependsOnMethod

groupOnClass()

public static groupOnClass(non-empty-string $groupName) : Group
Parameters
$groupName : non-empty-string
Return values
Group

groupOnMethod()

public static groupOnMethod(non-empty-string $groupName) : Group
Parameters
$groupName : non-empty-string
Return values
Group

isAfter()

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

After $this

Return values
bool

isAfterClass()

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

AfterClass $this

Return values
bool

isBackupGlobals()

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

BackupGlobals $this

Return values
bool

isBackupStaticProperties()

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

BackupStaticProperties $this

Return values
bool

isBefore()

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

Before $this

Return values
bool

isBeforeClass()

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

BeforeClass $this

Return values
bool

isClassLevel()

public isClassLevel() : bool
Return values
bool

isCovers()

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

Covers $this

Return values
bool

isCoversClass()

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

CoversClass $this

Return values
bool

isCoversDefaultClass()

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

CoversDefaultClass $this

Return values
bool

isCoversFunction()

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

CoversFunction $this

Return values
bool

isCoversMethod()

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

CoversMethod $this

Return values
bool

isCoversNothing()

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

CoversNothing $this

Return values
bool

isCoversTrait()

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

CoversTrait $this

Return values
bool

isDataProvider()

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

DataProvider $this

Return values
bool

isDependsOnClass()

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

DependsOnClass $this

Return values
bool

isDependsOnMethod()

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

DependsOnMethod $this

Return values
bool

isDisableReturnValueGenerationForTestDoubles()

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

DisableReturnValueGenerationForTestDoubles $this

Return values
bool

isDoesNotPerformAssertions()

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

DoesNotPerformAssertions $this

Return values
bool

isExcludeGlobalVariableFromBackup()

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

ExcludeGlobalVariableFromBackup $this

Return values
bool

isExcludeStaticPropertyFromBackup()

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

ExcludeStaticPropertyFromBackup $this

Return values
bool

isGroup()

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

Group $this

Return values
bool

isIgnoreDeprecations()

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

IgnoreDeprecations $this

Return values
bool

isMethodLevel()

public isMethodLevel() : bool
Return values
bool

isPostCondition()

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

PostCondition $this

Return values
bool

isPreCondition()

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

PreCondition $this

Return values
bool

isPreserveGlobalState()

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

PreserveGlobalState $this

Return values
bool

isRequiresFunction()

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

RequiresFunction $this

Return values
bool

isRequiresMethod()

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

RequiresMethod $this

Return values
bool

isRequiresOperatingSystem()

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

RequiresOperatingSystem $this

Return values
bool

isRequiresOperatingSystemFamily()

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

RequiresOperatingSystemFamily $this

Return values
bool

isRequiresPhp()

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

RequiresPhp $this

Return values
bool

isRequiresPhpExtension()

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

RequiresPhpExtension $this

Return values
bool

isRequiresPhpunit()

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

RequiresPhpunit $this

Return values
bool

isRequiresPhpunitExtension()

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

RequiresPhpunitExtension $this

Return values
bool

isRequiresSetting()

public isRequiresSetting() : true
Return values
true

isRunClassInSeparateProcess()

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

RunClassInSeparateProcess $this

Return values
bool

isRunInSeparateProcess()

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

RunInSeparateProcess $this

Return values
bool

isRunTestsInSeparateProcesses()

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

RunTestsInSeparateProcesses $this

Return values
bool

isTest()

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

Test $this

Return values
bool

isTestDox()

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

TestDox $this

Return values
bool

isTestWith()

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

TestWith $this

Return values
bool

isUses()

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

Uses $this

Return values
bool

isUsesClass()

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

UsesClass $this

Return values
bool

isUsesDefaultClass()

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

UsesDefaultClass $this

Return values
bool

isUsesFunction()

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

UsesFunction $this

Return values
bool

isUsesMethod()

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

UsesMethod $this

Return values
bool

isUsesTrait()

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

UsesTrait $this

Return values
bool

isWithoutErrorHandler()

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

WithoutErrorHandler $this

Return values
bool

requiresMethodOnClass()

public static requiresMethodOnClass(class-string $className, non-empty-string $methodName) : RequiresMethod
Parameters
$className : class-string
$methodName : non-empty-string
Return values
RequiresMethod

requiresMethodOnMethod()

public static requiresMethodOnMethod(class-string $className, non-empty-string $methodName) : RequiresMethod
Parameters
$className : class-string
$methodName : non-empty-string
Return values
RequiresMethod

requiresSettingOnClass()

public static requiresSettingOnClass(non-empty-string $setting, non-empty-string $value) : RequiresSetting
Parameters
$setting : non-empty-string
$value : non-empty-string
Return values
RequiresSetting

requiresSettingOnMethod()

public static requiresSettingOnMethod(non-empty-string $setting, non-empty-string $value) : RequiresSetting
Parameters
$setting : non-empty-string
$value : non-empty-string
Return values
RequiresSetting

setting()

public setting() : non-empty-string
Return values
non-empty-string

testDoxOnClass()

public static testDoxOnClass(non-empty-string $text) : TestDox
Parameters
$text : non-empty-string
Return values
TestDox

testDoxOnMethod()

public static testDoxOnMethod(non-empty-string $text) : TestDox
Parameters
$text : non-empty-string
Return values
TestDox

testWith()

public static testWith(mixed $data[, non-empty-string|null $name = null ]) : TestWith
Parameters
$data : mixed
$name : non-empty-string|null = null
Return values
TestWith

usesClass()

public static usesClass(class-string $className) : UsesClass
Parameters
$className : class-string
Return values
UsesClass

usesFunction()

public static usesFunction(non-empty-string $functionName) : UsesFunction
Parameters
$functionName : non-empty-string
Return values
UsesFunction

usesMethod()

public static usesMethod(class-string $className, non-empty-string $methodName) : UsesMethod
Parameters
$className : class-string
$methodName : non-empty-string
Return values
UsesMethod

usesOnClass()

public static usesOnClass(non-empty-string $target) : Uses
Parameters
$target : non-empty-string
Return values
Uses

usesOnMethod()

public static usesOnMethod(non-empty-string $target) : Uses
Parameters
$target : non-empty-string
Return values
Uses

usesTrait()

public static usesTrait(trait-string $traitName) : UsesTrait
Parameters
$traitName : trait-string
Return values
UsesTrait

value()

public value() : non-empty-string
Return values
non-empty-string

__construct()

protected __construct(0|1 $level, non-empty-string $setting, non-empty-string $value) : mixed
Parameters
$level : 0|1
$setting : non-empty-string
$value : non-empty-string
On this page

Search results