1. class
  2. StubTests
  3. \
  4. Unit
  5. \
  6. Validator
  7. \
  8. Classes
  9. \
  10. Methods
  11. \
  12. ClassStaticMethodsCheckTest

ClassStaticMethodsCheckTest

class ClassStaticMethodsCheckTest extends CheckTestCase (View source)

Methods

StubDataQueryInterface&Stub
createMockStorageManager()

Create a stubbed StubDataQueryInterface.

from  CheckTestCase
StubDataQueryInterface&MockObject
createStorageManagerMock()

Create a StubDataQueryInterface mock, for tests that constrain arguments with with() or assert call counts with expects().

from  CheckTestCase
PHPFunction
createMockFunction(string $name, array $parameters = [], $returnType = null)

Create a mock PHPFunction with the given id/name.

from  CheckTestCase
PHPClass
createMockClass(string $name, array $methods = [])

Create a mock PHPClass with the given id/name.

from  CheckTestCase
PHPClass
createMockClassWithProperties(string $name, string|null $namespace = null, bool|null $isFinal = null, bool|null $isReadonly = null, array $methods = [], PHPClass|null $parentClass = null, array $interfaces = [], array $properties = [])

Create a mock PHPClass with properties (isFinal, isReadonly, namespace, parentClass).

from  CheckTestCase
PHPProperty
createMockProperty(string $name, string|null $sinceVersion = null, string|null $removedVersion = null)

Create a mock PHPProperty with the given name and optional version bounds.

from  CheckTestCase
PHPMethod
createMockMethod(string $name, array $parameters = [], $returnType = null)

Create a mock PHPMethod with the given name.

from  CheckTestCase
PHPParameter
createMockParameter(string $name, mixed|null $type = null, string|null $sinceVersion = null, string|null $removedVersion = null, bool $isDeprecated = false, string|null $deprecatedSinceVersion = null)

Create a mock PHPParameter with the given name and type.

from  CheckTestCase
StandaloneType
createType(string $typeName)

Create a StandaloneType with the given type name.

from  CheckTestCase
object
createMockType(string $typeString)

Create a mock type that returns a string representation.

from  CheckTestCase
__construct(string $typeName)

No description

from  CheckTestCase
string
__toString()

No description

from  CheckTestCase
string
getTypeName()

No description

from  CheckTestCase
void
setUp()

No description

void
tearDown()

No description

void
testSupportsAllPhpVersions()

No description

void
testClassNotFoundInReflectionIsFailure()

No description

void
testClassNotFoundInStubsIsFailure()

No description

void
testClassWithNoMethodsSucceeds()

No description

void
testBothNonStaticIsSuccess()

No description

void
testBothStaticIsSuccess()

No description

void
testReflectionStaticStubNonStaticIsFailure()

No description

void
testReflectionNonStaticStubStaticIsFailure()

No description

void
testFailureMessageContainsExpectedAndActualModifiers()

No description

void
testMultipleMethodsMixedResultsAreAllReported()

No description

void
testAllMethodsMismatchedReportsAll()

No description

void
testMethodMissingInStubsIsNotReportedAsStaticMismatch()

No description

void
testClassLevelKnownProblemSkipsAllMethods()

No description

void
testMethodLevelKnownProblemSkipsSpecificMismatch()

No description

void
testMethodLevelKnownProblemDoesNotSuppressOtherMismatches()

No description

void
testStubMethodBelowSinceVersionIsExcluded()

No description

void
testStubMethodAfterRemovedVersionIsExcluded()

No description

void
testStubMethodWithinVersionRangeIsIncluded()

No description

void
testPsUnreservePrefixMismatchIsReported()

No description

void
testPsUnreservePrefixMatchIsSuccess()

No description

void
testStaticMethodInheritedFromParentMismatchIsReported()

No description

void
testStaticMethodInheritedFromParentMatchIsSuccess()

No description

void
testChildMethodOverridesParentForStaticCheck()

No description

void
testStaticMethodFromInterfaceMismatchIsReported()

No description

void
testStaticMethodFromInterfaceMatchIsSuccess()

No description

void
testClassMethodWinsOverInterfaceMethodForStaticCheck()

No description

void
testCyclicParentChainTerminatesAndStillCollectsFromTheParent()

\MyClass.parentClass = \ParentClass; \ParentClass.parentClass = \MyClass → a real cycle.

Details

in CheckTestCase at line 40
protected StubDataQueryInterface&Stub createMockStorageManager()

Create a stubbed StubDataQueryInterface.

A stub rather than a mock: these doubles only supply return values and never verify interactions, so createMock() made PHPUnit emit "No expectations were configured for the mock object" for every one of them — 1777 notices from this helper alone.

The return type names the double explicitly (&Stub) instead of just the interface, so ->method(...) resolves for static analysis; previously every such call across ~90 test files was reported as an undefined method, burying real warnings.

Return Value

StubDataQueryInterface&Stub

in CheckTestCase at line 53
protected StubDataQueryInterface&MockObject createStorageManagerMock()

Create a StubDataQueryInterface mock, for tests that constrain arguments with with() or assert call counts with expects().

Those only work on a mock: on a stub, with() is silently ignored (PHPUnit deprecates it and will remove it in 13), so a test using the stub helper would appear to pin the argument while actually accepting anything.

Return Value

StubDataQueryInterface&MockObject

in CheckTestCase at line 61
protected PHPFunction createMockFunction(string $name, array $parameters = [], $returnType = null)

Create a mock PHPFunction with the given id/name.

Parameters

string $name
array $parameters
$returnType

Return Value

PHPFunction

in CheckTestCase at line 82
protected PHPClass createMockClass(string $name, array $methods = [])

Create a mock PHPClass with the given id/name.

Parameters

string $name
array $methods

Return Value

PHPClass

in CheckTestCase at line 103
protected PHPClass createMockClassWithProperties(string $name, string|null $namespace = null, bool|null $isFinal = null, bool|null $isReadonly = null, array $methods = [], PHPClass|null $parentClass = null, array $interfaces = [], array $properties = [])

Create a mock PHPClass with properties (isFinal, isReadonly, namespace, parentClass).

Parameters

string $name

Class name/ID
string|null $namespace

Class namespace
bool|null $isFinal

Whether class is final
bool|null $isReadonly

Whether class is readonly
array $methods

Array of methods
PHPClass|null $parentClass

Parent class object
array $interfaces
array $properties

Return Value

PHPClass

in CheckTestCase at line 144
protected PHPProperty createMockProperty(string $name, string|null $sinceVersion = null, string|null $removedVersion = null)

Create a mock PHPProperty with the given name and optional version bounds.

Parameters

string $name
string|null $sinceVersion
string|null $removedVersion

Return Value

PHPProperty

in CheckTestCase at line 159
protected PHPMethod createMockMethod(string $name, array $parameters = [], $returnType = null)

Create a mock PHPMethod with the given name.

Parameters

string $name
array $parameters
$returnType

Return Value

PHPMethod

in CheckTestCase at line 190
protected PHPParameter createMockParameter(string $name, mixed|null $type = null, string|null $sinceVersion = null, string|null $removedVersion = null, bool $isDeprecated = false, string|null $deprecatedSinceVersion = null)

Create a mock PHPParameter with the given name and type.

Note: Supports both getDeclaredType() and getType() methods to be compatible with different validators (ParameterNamesCheck uses getName, ParameterTypesCheck uses getType).

Parameters

string $name

Parameter name
mixed|null $type

Parameter type (optional)
string|null $sinceVersion

Version when parameter was introduced (optional)
string|null $removedVersion

Version when parameter was removed (optional)
bool $isDeprecated

Whether the parameter is marked deprecated
string|null $deprecatedSinceVersion

PHP version the deprecation starts at; null means "deprecated in every version"

Return Value

PHPParameter

in CheckTestCase at line 217
protected StandaloneType createType(string $typeName)

Create a StandaloneType with the given type name.

Parameters

string $typeName

Return Value

StandaloneType

in CheckTestCase at line 225
protected object createMockType(string $typeString)

Create a mock type that returns a string representation.

Parameters

string $typeString

Return Value

object

in CheckTestCase at line 228
__construct(string $typeName)

No description

Parameters

string $typeName

in CheckTestCase at line 230
string __toString()

No description

Return Value

string

in CheckTestCase at line 232
string getTypeName()

No description

Return Value

string

at line 20
protected void setUp()

No description

Return Value

void

at line 27
protected void tearDown()

No description

Return Value

void

at line 35
void testSupportsAllPhpVersions()

No description

Return Value

void

at line 45
void testClassNotFoundInReflectionIsFailure()

No description

Return Value

void

at line 60
void testClassNotFoundInStubsIsFailure()

No description

Return Value

void

at line 77
void testClassWithNoMethodsSucceeds()

No description

Return Value

void

at line 93
void testBothNonStaticIsSuccess()

No description

Return Value

void

at line 120
void testBothStaticIsSuccess()

No description

Return Value

void

at line 149
void testReflectionStaticStubNonStaticIsFailure()

No description

Return Value

void

at line 180
void testReflectionNonStaticStubStaticIsFailure()

No description

Return Value

void

at line 208
void testFailureMessageContainsExpectedAndActualModifiers()

No description

Return Value

void

at line 239
void testMultipleMethodsMixedResultsAreAllReported()

No description

Return Value

void

at line 274
void testAllMethodsMismatchedReportsAll()

No description

Return Value

void

at line 312
void testMethodMissingInStubsIsNotReportedAsStaticMismatch()

No description

Return Value

void

at line 335
void testClassLevelKnownProblemSkipsAllMethods()

No description

Return Value

void

at line 383
void testMethodLevelKnownProblemSkipsSpecificMismatch()

No description

Return Value

void

at line 436
void testMethodLevelKnownProblemDoesNotSuppressOtherMismatches()

No description

Return Value

void

at line 490
void testStubMethodBelowSinceVersionIsExcluded()

No description

Return Value

void

at line 517
void testStubMethodAfterRemovedVersionIsExcluded()

No description

Return Value

void

at line 544
void testStubMethodWithinVersionRangeIsIncluded()

No description

Return Value

void

at line 574
void testPsUnreservePrefixMismatchIsReported()

No description

Return Value

void

at line 602
void testPsUnreservePrefixMatchIsSuccess()

No description

Return Value

void

at line 631
void testStaticMethodInheritedFromParentMismatchIsReported()

No description

Return Value

void

at line 661
void testStaticMethodInheritedFromParentMatchIsSuccess()

No description

Return Value

void

at line 690
void testChildMethodOverridesParentForStaticCheck()

No description

Return Value

void

at line 729
void testStaticMethodFromInterfaceMismatchIsReported()

No description

Return Value

void

at line 764
void testStaticMethodFromInterfaceMatchIsSuccess()

No description

Return Value

void

at line 798
void testClassMethodWinsOverInterfaceMethodForStaticCheck()

No description

Return Value

void

at line 846
void testCyclicParentChainTerminatesAndStillCollectsFromTheParent()

\MyClass.parentClass = \ParentClass; \ParentClass.parentClass = \MyClass → a real cycle.

Without the visited-set guard in MethodCollectionService::collectForClass() the while-loop never reaches null and $visited grows until the process dies.

The parent carries the mismatching declaration on purpose: asserting the resulting failure proves the walk actually entered the parent before breaking. A guard that bailed out one step too early would terminate just as happily and report nothing, which assertFalse(hasFailures()) cannot tell apart from a correct traversal.

Return Value

void