ClassConstantsCheck
class ClassConstantsCheck extends AbstractClassCheck (View source)
Validates that constants declared in class stubs exist in reflection.
PHP reflection reports ALL constants of a class including those inherited via the parent-class chain and implemented interfaces. Stubs only declare constants that are directly introduced (not inherited), so we cannot simply require every reflection constant to appear in the stub.
For each constant declared directly in the stub, this check verifies it appears in reflection's full constant list (which includes all inherited ones).
This catches spurious constants declared in stubs that don't exist anywhere in reflection.
Visibility is validated separately by ClassConstantsVisibilityCheck. Values are validated separately by ClassConstantsValueCheck.
For interfaces and enums, pass EntityTypeConfig::forInterface() or EntityTypeConfig::forEnum() to override the entity-lookup and label methods.
Known problems are supported at two levels:
- Entity-level: EntityType::CLASS_TYPE + classId + 'ClassConstantsCheck' → skips entire class.
- Constant-level: EntityType::CLASS_CONSTANT + 'ClassName::CONST' + 'ClassConstantsCheck' → skips one constant.
Properties
| protected ReflectionProviderInterface | $reflectionProvider | from AbstractReflectionCheck | |
| protected KnownProblemsRegistry | $knownProblemsRegistry | from AbstractReflectionCheck | |
| protected EntityLookupService | $entityLookup | from AbstractClassCheck | |
| protected MethodCollectionService | $methodCollection | from AbstractClassCheck | |
| protected EntityTypeConfig|null | $entityTypeConfig | from AbstractClassCheck |
Methods
No description
Records a skipped-success result if a known problem covers this entity, and returns true.
Look up an entity by ID, dispatching to the right lookup method based on config.
Collect version-filtered methods, dispatching based on config.
Collect version-filtered properties, dispatching based on config.
No description
No description
Details
__construct(ReflectionProviderInterface|null $reflectionProvider = null, KnownProblemsRegistry|null $knownProblemsRegistry = null, EntityLookupService|null $entityLookup = null, MethodCollectionService|null $methodCollection = null, EntityTypeConfig|null $entityTypeConfig = null)
No description
protected bool
skipWithKnownProblem(CheckResultSet $results, string $entityType, string $entityId, string $checkName, string $phpVersion)
Records a skipped-success result if a known problem covers this entity, and returns true.
Returns false if validation should proceed normally.
protected PHPClassLikeObject|null
lookupEntityById(StubDataQueryInterface $storage, string $entityId)
Look up an entity by ID, dispatching to the right lookup method based on config.
Defaults to class lookup when no config is set.
protected array
collectEntityMethodsByConfig(PHPClassLikeObject $entity, string $phpVersion)
Collect version-filtered methods, dispatching based on config.
Defaults to class hierarchy traversal when no config is set.
protected array
collectEntityPropertiesByConfig(PHPClassLikeObject $entity, string $phpVersion)
Collect version-filtered properties, dispatching based on config.
Only classes have properties; returns empty array for enum/interface.
protected string
getEntityLabel()
No description
protected string
getEntityType()
No description
protected string
getConstantEntityType()
No description
protected PHPClass|null
findClassById(StubDataQueryInterface $storage, string $entityId)
No description
protected PHPEnum|null
findEnumById(StubDataQueryInterface $storage, string $entityId)
No description
protected PHPInterface|null
findInterfaceById(StubDataQueryInterface $storage, string $entityId)
No description
bool
supports(string $phpVersion)
No description
CheckResultSet
run(StubDataQueryInterface $stubs, string $entityId, string $phpVersion)
No description
protected string
getCheckName()
No description