Component::lookup nullable when $need=false

Author: adaamz

README.md

@@ -12,6 +12,7 @@ This extension provides following features:
 * `Nette\ComponentModel\Container::getComponent()` knows type of the component because it reads the return type on `createComponent*` (this works best in presenters and controls)
 * `Nette\DI\Container::getByType` and `createInstance` return type based on first parameter (`Foo::class`).
 * `Nette\Forms\Container::getValues` return type based on `$asArray` parameter.
+* `Nette\ComponentModel\Component::lookup` return type based on `$need` parameter.
 * Dynamic methods of [Nette\Utils\Html](https://doc.nette.org/en/2.4/html-elements)
 * Magic [Nette\Object and Nette\SmartObject](https://doc.nette.org/en/2.4/php-language-enhancements) properties
 * Event listeners through the `on*` properties

extension.neon

@@ -33,6 +33,11 @@ services:
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 
+	-
+		class: PHPStan\Type\Nette\ComponentLookupMethodReflectionExtension
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension
+
 	-
 		class: PHPStan\Type\Nette\FormsBaseControlDynamicReturnTypeExtension
 		tags:

src/Type/Nette/ComponentLookupMethodReflectionExtension.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Nette;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\NullType;
+use PHPStan\Type\Type;
+use PHPStan\Type\UnionType;
+
+final class ComponentLookupMethodReflectionExtension implements DynamicMethodReturnTypeExtension
+{
+
+	public function getClass(): string
+	{
+		return \Nette\ComponentModel\Component::class;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'lookup';
+	}
+
+	public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+	{
+		if (count($methodCall->args) > 1) {
+			$paramNeedExpr = $methodCall->args[1]->value;
+			$paramNeedType = $scope->getType($paramNeedExpr);
+
+			if ($paramNeedType instanceof ConstantBooleanType && $paramNeedType->getValue() === false) {
+				if ($methodReflection->getReturnType()->accepts(new NullType()) === false) {
+					return new UnionType([$methodReflection->getReturnType(), new NullType()]);
+				}
+			}
+		}
+
+		return $methodReflection->getReturnType();
+	}
+
+}