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

ClassMethodsPhpDocConformsSignatureCheckTest

class ClassMethodsPhpDocConformsSignatureCheckTest extends CheckTestCase (View source)

Methods

StubDataQueryInterface
createMockStorageManager()

Create a mock StubDataQueryInterface.

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)

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
testSupportsAllVersions()

No description

void
testClassAbsentFromStubsSucceedsSilently()

No description

void
testClassWithNoMethodsSucceeds()

No description

void
testMatchingReturnTypePasses()

No description

void
testIncompatibleReturnTypeFails()

No description

void
testParamTypeMismatchFails()

No description

void
testNoPhpDocReturnTypeIsSkipped()

No description

void
testPropertyTypeMismatchFails()

No description

void
testPropertyTypeMatchPasses()

No description

void
testPropertyNoPhpDocIsSkipped()

No description

void
testTypedArrayNarrowingPasses()

No description

void
testPhpStanGenericsPass()

No description

void
testBoolFalseNarrowingPasses()

No description

void
testClassLevelKnownProblemSkips()

No description

void
testMethodLevelKnownProblemSkipsSpecificMismatch()

No description

Details

in CheckTestCase at line 30
protected StubDataQueryInterface createMockStorageManager()

Create a mock StubDataQueryInterface.

Return Value

StubDataQueryInterface

in CheckTestCase at line 38
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 59
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 80
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 121
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 136
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 164
protected PHPParameter createMockParameter(string $name, mixed|null $type = null, string|null $sinceVersion = null, string|null $removedVersion = 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)

Return Value

PHPParameter

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

Create a StandaloneType with the given type name.

Parameters

string $typeName

Return Value

StandaloneType

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

Create a mock type that returns a string representation.

Parameters

string $typeString

Return Value

object

in CheckTestCase at line 192
__construct(string $typeName)

No description

Parameters

string $typeName

in CheckTestCase at line 194
string __toString()

No description

Return Value

string

in CheckTestCase at line 196
string getTypeName()

No description

Return Value

string

at line 22
protected void setUp()

No description

Return Value

void

at line 29
protected void tearDown()

No description

Return Value

void

at line 37
void testSupportsAllVersions()

No description

Return Value

void

at line 46
void testClassAbsentFromStubsSucceedsSilently()

No description

Return Value

void

at line 59
void testClassWithNoMethodsSucceeds()

No description

Return Value

void

at line 75
void testMatchingReturnTypePasses()

No description

Return Value

void

at line 91
void testIncompatibleReturnTypeFails()

No description

Return Value

void

at line 111
void testParamTypeMismatchFails()

No description

Return Value

void

at line 134
void testNoPhpDocReturnTypeIsSkipped()

No description

Return Value

void

at line 150
void testPropertyTypeMismatchFails()

No description

Return Value

void

at line 178
void testPropertyTypeMatchPasses()

No description

Return Value

void

at line 202
void testPropertyNoPhpDocIsSkipped()

No description

Return Value

void

at line 228
void testTypedArrayNarrowingPasses()

No description

Return Value

void

at line 244
void testPhpStanGenericsPass()

No description

Return Value

void

at line 260
void testBoolFalseNarrowingPasses()

No description

Return Value

void

at line 276
void testClassLevelKnownProblemSkips()

No description

Return Value

void

at line 310
void testMethodLevelKnownProblemSkipsSpecificMismatch()

No description

Return Value

void