missingPropertiesFactory = $missingPropertiesFactory; $this->localPropertyAnalyzer = $localPropertyAnalyzer; $this->classLikeAnalyzer = $classLikeAnalyzer; $this->reflectionProvider = $reflectionProvider; $this->classAnalyzer = $classAnalyzer; $this->propertyPresenceChecker = $propertyPresenceChecker; $this->phpAttributeAnalyzer = $phpAttributeAnalyzer; } public function getRuleDefinition() : RuleDefinition { return new RuleDefinition('Add missing dynamic properties', [new CodeSample(<<<'CODE_SAMPLE' class SomeClass { public function set() { $this->value = 5; } } CODE_SAMPLE , <<<'CODE_SAMPLE' class SomeClass { /** * @var int */ public $value; public function set() { $this->value = 5; } } CODE_SAMPLE )]); } /** * @return array> */ public function getNodeTypes() : array { return [Class_::class]; } /** * @param Class_ $node */ public function refactor(Node $node) : ?Node { if ($this->shouldSkipClass($node)) { return null; } $className = $this->getName($node); if ($className === null) { return null; } if (!$this->reflectionProvider->hasClass($className)) { return null; } $classReflection = $this->reflectionProvider->getClass($className); // special case for Laravel Collection macro magic $fetchedLocalPropertyNameToTypes = $this->localPropertyAnalyzer->resolveFetchedPropertiesToTypesFromClass($node); $propertiesToComplete = $this->resolvePropertiesToComplete($node, $fetchedLocalPropertyNameToTypes); if ($propertiesToComplete === []) { return null; } $propertiesToComplete = $this->filterOutExistingProperties($node, $classReflection, $propertiesToComplete); $newProperties = $this->missingPropertiesFactory->create($fetchedLocalPropertyNameToTypes, $propertiesToComplete); if ($newProperties === []) { return null; } $node->stmts = \array_merge($newProperties, $node->stmts); return $node; } private function shouldSkipClass(Class_ $class) : bool { if ($this->classAnalyzer->isAnonymousClass($class)) { return \true; } $className = (string) $this->nodeNameResolver->getName($class); if (!$this->reflectionProvider->hasClass($className)) { return \true; } if ($this->phpAttributeAnalyzer->hasPhpAttribute($class, 'AllowDynamicProperties')) { return \true; } $classReflection = $this->reflectionProvider->getClass($className); // properties are accessed via magic, nothing we can do if ($classReflection->hasMethod('__set')) { return \true; } if ($classReflection->hasMethod('__get')) { return \true; } return $class->extends instanceof FullyQualified && !$this->reflectionProvider->hasClass($class->extends->toString()); } /** * @param array $fetchedLocalPropertyNameToTypes * @return string[] */ private function resolvePropertiesToComplete(Class_ $class, array $fetchedLocalPropertyNameToTypes) : array { $propertyNames = $this->classLikeAnalyzer->resolvePropertyNames($class); /** @var string[] $fetchedLocalPropertyNames */ $fetchedLocalPropertyNames = \array_keys($fetchedLocalPropertyNameToTypes); return \array_diff($fetchedLocalPropertyNames, $propertyNames); } /** * @param string[] $propertiesToComplete * @return string[] */ private function filterOutExistingProperties(Class_ $class, ClassReflection $classReflection, array $propertiesToComplete) : array { $missingPropertyNames = []; $className = $classReflection->getName(); // remove other properties that are accessible from this scope foreach ($propertiesToComplete as $propertyToComplete) { if ($classReflection->hasProperty($propertyToComplete)) { continue; } $propertyMetadata = new PropertyMetadata($propertyToComplete, new ObjectType($className)); $hasClassContextProperty = $this->propertyPresenceChecker->hasClassContextProperty($class, $propertyMetadata); if ($hasClassContextProperty) { continue; } $missingPropertyNames[] = $propertyToComplete; } return $missingPropertyNames; } }