1. class
  2. StubTests
  3. \
  4. Unit
  5. \
  6. Validator
  7. \
  8. PhpDoc
  9. \
  10. PhpDocVersionFormatCheckTest

PhpDocVersionFormatCheckTest

class PhpDocVersionFormatCheckTest extends PhpDocCheckTestCase (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
PHPMethod
makeMethodWithPhpDoc(string $name, string|null $phpDoc = null)

No description

from  PhpDocCheckTestCase
PHPFunction
makePhpDocFunction(string $id, string|null $phpDoc = null)

No description

from  PhpDocCheckTestCase
StubDataQueryInterface
makeStubsWithClass(PHPClass $class)

No description

from  PhpDocCheckTestCase
StubDataQueryInterface
makeStubsWithFunction(PHPFunction $function)

No description

from  PhpDocCheckTestCase
void
setUp()

No description

void
tearDown()

No description

void
testSupportsAllVersions()

No description

void
testEntityNotFoundSucceeds()

No description

void
testEntityWithNoPhpDocSucceeds()

No description

void
testFunctionWithNoPhpDocSucceeds()

No description

static array
validVersionProvider()

No description

void
testValidVersionSucceeds(string $tag, string $version)

No description

static array
patchVersionProvider()

No description

void
testPatchVersionIsFailure(string $tag, string $version, string $expectedMajorMinor)

No description

void
testLibvirtStyleVersionNotFlagged()

No description

void
testLibvirtStyleVersionWithDash2NotFlagged()

No description

void
testPatchVersionInMethodPhpDocIsFailure()

No description

void
testValidVersionInMethodPhpDocSucceeds()

No description

void
testMultiplePatchVersionsAllReported()

No description

void
testFunctionWithValidVersionSucceeds()

No description

void
testFunctionWithPatchVersionIsFailure()

No description

void
testKnownProblemAtEntityLevelSkipsCheck()

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

in PhpDocCheckTestCase at line 16
protected PHPMethod makeMethodWithPhpDoc(string $name, string|null $phpDoc = null)

No description

Parameters

string $name
string|null $phpDoc

Return Value

PHPMethod

in PhpDocCheckTestCase at line 26
protected PHPFunction makePhpDocFunction(string $id, string|null $phpDoc = null)

No description

Parameters

string $id
string|null $phpDoc

Return Value

PHPFunction

in PhpDocCheckTestCase at line 37
protected StubDataQueryInterface makeStubsWithClass(PHPClass $class)

No description

Parameters

PHPClass $class

Return Value

StubDataQueryInterface

in PhpDocCheckTestCase at line 47
protected StubDataQueryInterface makeStubsWithFunction(PHPFunction $function)

No description

Parameters

PHPFunction $function

Return Value

StubDataQueryInterface

at line 19
protected void setUp()

No description

Return Value

void

at line 26
protected void tearDown()

No description

Return Value

void

at line 41
void testSupportsAllVersions()

No description

Return Value

void

at line 51
void testEntityNotFoundSucceeds()

No description

Return Value

void

at line 66
void testEntityWithNoPhpDocSucceeds()

No description

Return Value

void

at line 73
void testFunctionWithNoPhpDocSucceeds()

No description

Return Value

void

at line 85
static array validVersionProvider()

No description

Return Value

array

at line 99
void testValidVersionSucceeds(string $tag, string $version)

No description

Parameters

string $tag
string $version

Return Value

void

at line 113
static array patchVersionProvider()

No description

Return Value

array

at line 127
void testPatchVersionIsFailure(string $tag, string $version, string $expectedMajorMinor)

No description

Parameters

string $tag
string $version
string $expectedMajorMinor

Return Value

void

at line 139
void testLibvirtStyleVersionNotFlagged()

No description

Return Value

void

at line 148
void testLibvirtStyleVersionWithDash2NotFlagged()

No description

Return Value

void

at line 158
void testPatchVersionInMethodPhpDocIsFailure()

No description

Return Value

void

at line 168
void testValidVersionInMethodPhpDocSucceeds()

No description

Return Value

void

at line 178
void testMultiplePatchVersionsAllReported()

No description

Return Value

void

at line 191
void testFunctionWithValidVersionSucceeds()

No description

Return Value

void

at line 199
void testFunctionWithPatchVersionIsFailure()

No description

Return Value

void

at line 209
void testKnownProblemAtEntityLevelSkipsCheck()

No description

Return Value

void