changedFilesDetector = $changedFilesDetector; $this->dependencyResolver = $dependencyResolver; $this->nodeScopeResolver = $nodeScopeResolver; $this->reflectionProvider = $reflectionProvider; $this->scopeFactory = $scopeFactory; $this->privatesAccessor = $privatesAccessor; $this->nodeNameResolver = $nodeNameResolver; $this->classAnalyzer = $classAnalyzer; $this->fileWithoutNamespaceNodeTraverser = $fileWithoutNamespaceNodeTraverser; $this->nodeTraverser = new NodeTraverser(); foreach ($nodeVisitors as $nodeVisitor) { $this->nodeTraverser->addVisitor($nodeVisitor); } } /** * @param Stmt[] $stmts * @return Stmt[] */ public function processNodes(array $stmts, string $filePath, ?MutatingScope $formerMutatingScope = null) : array { $isScopeRefreshing = $formerMutatingScope instanceof MutatingScope; /** * The stmts must be array of Stmt, or it will be silently skipped by PHPStan * @see vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php:282 */ Assert::allIsInstanceOf($stmts, Stmt::class); $isInitFileWithoutNamespace = \false; if (!$isScopeRefreshing && !\current($stmts) instanceof FileWithoutNamespace) { $stmts = $this->fileWithoutNamespaceNodeTraverser->traverse($stmts); $currentStmt = \current($stmts); if ($currentStmt instanceof FileWithoutNamespace) { $this->nodeTraverser->traverse($stmts); $stmts = $currentStmt->stmts; $isInitFileWithoutNamespace = \true; } } if (!$isInitFileWithoutNamespace) { $this->nodeTraverser->traverse($stmts); } $scope = $formerMutatingScope ?? $this->scopeFactory->createFromFile($filePath); // skip chain method calls, performance issue: https://github.com/phpstan/phpstan/issues/254 $nodeCallback = function (Node $node, MutatingScope $mutatingScope) use(&$nodeCallback, $isScopeRefreshing, $filePath) : void { if (($node instanceof Expression || $node instanceof Return_ || $node instanceof Assign || $node instanceof EnumCase || $node instanceof AssignOp || $node instanceof Cast) && $node->expr instanceof Expr) { $node->expr->setAttribute(AttributeKey::SCOPE, $mutatingScope); } if ($node instanceof Ternary) { $this->processTernary($node, $mutatingScope); } if ($node instanceof BinaryOp) { $this->processBinaryOp($node, $mutatingScope); } if ($node instanceof Arg) { $node->value->setAttribute(AttributeKey::SCOPE, $mutatingScope); } if ($node instanceof Foreach_) { // decorate value as well $node->valueVar->setAttribute(AttributeKey::SCOPE, $mutatingScope); if ($node->valueVar instanceof Array_) { $this->processArray($node->valueVar, $mutatingScope); } } if ($node instanceof Array_) { $this->processArray($node, $mutatingScope); } if ($node instanceof Property) { $this->processProperty($node, $mutatingScope); } if ($node instanceof Switch_) { $this->processSwitch($node, $mutatingScope); } if ($node instanceof TryCatch) { $this->processTryCatch($node, $filePath, $mutatingScope); } if ($node instanceof ArrayItem) { $this->processArrayItem($node, $mutatingScope); } if ($node instanceof FuncCall && $node->name instanceof Expr) { $node->name->setAttribute(AttributeKey::SCOPE, $mutatingScope); } if ($node instanceof Assign || $node instanceof AssignOp) { // decorate value as well $node->var->setAttribute(AttributeKey::SCOPE, $mutatingScope); } if ($node instanceof Trait_) { $traitName = $this->resolveClassName($node); $traitClassReflection = $this->reflectionProvider->getClass($traitName); $traitScope = clone $mutatingScope; $scopeContext = $this->privatesAccessor->getPrivatePropertyOfClass($traitScope, self::CONTEXT, ScopeContext::class); $traitContext = clone $scopeContext; // before entering the class/trait again, we have to tell scope no class was set, otherwise it crashes $this->privatesAccessor->setPrivatePropertyOfClass($traitContext, 'classReflection', $traitClassReflection, ClassReflection::class); $this->privatesAccessor->setPrivatePropertyOfClass($traitScope, self::CONTEXT, $traitContext, ScopeContext::class); $node->setAttribute(AttributeKey::SCOPE, $traitScope); $this->nodeScopeResolver->processNodes($node->stmts, $traitScope, $nodeCallback); $this->decorateTraitAttrGroups($node, $traitScope); return; } // the class reflection is resolved AFTER entering to class node // so we need to get it from the first after this one if ($node instanceof Class_ || $node instanceof Interface_ || $node instanceof Enum_) { /** @var MutatingScope $mutatingScope */ $mutatingScope = $this->resolveClassOrInterfaceScope($node, $mutatingScope, $isScopeRefreshing); } if ($node instanceof Stmt) { $this->setChildOfUnreachableStatementNodeAttribute($node, $mutatingScope); } // special case for unreachable nodes if ($node instanceof UnreachableStatementNode) { $this->processUnreachableStatementNode($node, $filePath, $mutatingScope); } else { $node->setAttribute(AttributeKey::SCOPE, $mutatingScope); } }; return $this->processNodesWithDependentFiles($filePath, $stmts, $scope, $nodeCallback); } private function setChildOfUnreachableStatementNodeAttribute(Stmt $stmt, MutatingScope $mutatingScope) : void { if (!$stmt instanceof StmtsAwareInterface && !$stmt instanceof ClassLike && !$stmt instanceof Declare_) { return; } if ($stmt->getAttribute(AttributeKey::IS_UNREACHABLE) !== \true) { return; } if ($stmt->stmts === null) { return; } foreach ($stmt->stmts as $childStmt) { $childStmt->setAttribute(AttributeKey::IS_UNREACHABLE, \true); $childStmt->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } private function processArray(Array_ $array, MutatingScope $mutatingScope) : void { foreach ($array->items as $arrayItem) { if ($arrayItem instanceof ArrayItem) { $arrayItem->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } } private function processArrayItem(ArrayItem $arrayItem, MutatingScope $mutatingScope) : void { if ($arrayItem->key instanceof Expr) { $arrayItem->key->setAttribute(AttributeKey::SCOPE, $mutatingScope); } $arrayItem->value->setAttribute(AttributeKey::SCOPE, $mutatingScope); } private function decorateTraitAttrGroups(Trait_ $trait, MutatingScope $mutatingScope) : void { foreach ($trait->attrGroups as $attrGroup) { foreach ($attrGroup->attrs as $attr) { foreach ($attr->args as $arg) { $arg->value->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } } } private function processSwitch(Switch_ $switch, MutatingScope $mutatingScope) : void { // decorate value as well foreach ($switch->cases as $case) { $case->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } private function processTryCatch(TryCatch $tryCatch, string $filePath, MutatingScope $mutatingScope) : void { foreach ($tryCatch->catches as $catch) { $varName = $catch->var instanceof Variable ? $this->nodeNameResolver->getName($catch->var) : null; $type = TypeCombinator::union(...\array_map(static function (Name $name) : ObjectType { return new ObjectType((string) $name); }, $catch->types)); $catchMutatingScope = $mutatingScope->enterCatchType($type, $varName); $this->processNodes($catch->stmts, $filePath, $catchMutatingScope); } if ($tryCatch->finally instanceof Finally_) { $tryCatch->finally->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } private function processUnreachableStatementNode(UnreachableStatementNode $unreachableStatementNode, string $filePath, MutatingScope $mutatingScope) : void { $originalStmt = $unreachableStatementNode->getOriginalStatement(); $originalStmt->setAttribute(AttributeKey::IS_UNREACHABLE, \true); $originalStmt->setAttribute(AttributeKey::SCOPE, $mutatingScope); $this->processNodes([$originalStmt], $filePath, $mutatingScope); $parentNode = $unreachableStatementNode->getAttribute(AttributeKey::PARENT_NODE); if (!$parentNode instanceof StmtsAwareInterface && !$parentNode instanceof ClassLike && !$parentNode instanceof Declare_) { return; } $stmtKey = $unreachableStatementNode->getAttribute(AttributeKey::STMT_KEY); $totalKeys = $parentNode->stmts === null ? 0 : \count($parentNode->stmts); for ($key = $stmtKey + 1; $key < $totalKeys; ++$key) { if (!isset($parentNode->stmts[$key])) { continue; } $parentNode->stmts[$key]->setAttribute(AttributeKey::IS_UNREACHABLE, \true); $this->processNodes([$parentNode->stmts[$key]], $filePath, $mutatingScope); } } private function processProperty(Property $property, MutatingScope $mutatingScope) : void { foreach ($property->props as $propertyProperty) { $propertyProperty->setAttribute(AttributeKey::SCOPE, $mutatingScope); if ($propertyProperty->default instanceof Expr) { $propertyProperty->default->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } foreach ($property->attrGroups as $attrGroup) { foreach ($attrGroup->attrs as $attribute) { $attribute->setAttribute(AttributeKey::SCOPE, $mutatingScope); } } } private function processBinaryOp(BinaryOp $binaryOp, MutatingScope $mutatingScope) : void { $binaryOp->left->setAttribute(AttributeKey::SCOPE, $mutatingScope); $binaryOp->right->setAttribute(AttributeKey::SCOPE, $mutatingScope); } private function processTernary(Ternary $ternary, MutatingScope $mutatingScope) : void { if ($ternary->if instanceof Expr) { $ternary->if->setAttribute(AttributeKey::SCOPE, $mutatingScope); } $ternary->else->setAttribute(AttributeKey::SCOPE, $mutatingScope); } /** * @param Stmt[] $stmts * @param callable(Node $node, MutatingScope $scope): void $nodeCallback * @return Stmt[] */ private function processNodesWithDependentFiles(string $filePath, array $stmts, MutatingScope $mutatingScope, callable $nodeCallback) : array { $this->nodeScopeResolver->processNodes($stmts, $mutatingScope, $nodeCallback); $this->resolveAndSaveDependentFiles($stmts, $mutatingScope, $filePath); return $stmts; } /** * @param \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Enum_ $classLike */ private function resolveClassOrInterfaceScope($classLike, MutatingScope $mutatingScope, bool $isScopeRefreshing) : MutatingScope { $className = $this->resolveClassName($classLike); $isAnonymous = $this->classAnalyzer->isAnonymousClass($classLike); // is anonymous class? - not possible to enter it since PHPStan 0.12.33, see https://github.com/phpstan/phpstan-src/commit/e87fb0ec26f9c8552bbeef26a868b1e5d8185e91 if ($classLike instanceof Class_ && $isAnonymous) { $classReflection = $this->reflectionProvider->getAnonymousClassReflection($classLike, $mutatingScope); } elseif (!$this->reflectionProvider->hasClass($className)) { return $mutatingScope; } else { $classReflection = $this->reflectionProvider->getClass($className); } // on refresh, remove entered class avoid entering the class again if ($isScopeRefreshing && $mutatingScope->isInClass() && !$isAnonymous) { $context = $this->privatesAccessor->getPrivateProperty($mutatingScope, 'context'); $this->privatesAccessor->setPrivateProperty($context, 'classReflection', null); } return $mutatingScope->enterClass($classReflection); } /** * @param \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_ $classLike */ private function resolveClassName($classLike) : string { if ($classLike->namespacedName instanceof Name) { return (string) $classLike->namespacedName; } if (!$classLike->name instanceof Identifier) { throw new ShouldNotHappenException(); } return $classLike->name->toString(); } /** * @param Stmt[] $stmts */ private function resolveAndSaveDependentFiles(array $stmts, MutatingScope $mutatingScope, string $filePath) : void { $dependentFiles = []; foreach ($stmts as $stmt) { try { $nodeDependentFiles = $this->dependencyResolver->resolveDependencies($stmt, $mutatingScope); $dependentFiles = \array_merge($dependentFiles, $nodeDependentFiles); } catch (AnalysedCodeException $exception) { // @ignoreException } } $this->changedFilesDetector->addFileDependentFiles($filePath, $dependentFiles); } }