getComponent() by default does not return null for unknown components

Author: ondrejmirtes

src/Type/Nette/ComponentModelArrayAccessDynamicReturnTypeExtension.php

@@ -7,6 +7,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use function count;
@@ -36,6 +37,7 @@ public function getTypeFromMethodCall(
 	{
 		$calledOnType = $scope->getType($methodCall->var);
 		$defaultType = ParametersAcceptorSelector::selectSingle($calledOnType->getMethod('createComponent', $scope)->getVariants())->getReturnType();
+		$defaultType = TypeCombinator::remove($defaultType, new NullType());
 		$args = $methodCall->getArgs();
 		if (count($args) !== 1) {
 			return $defaultType;

src/Type/Nette/ComponentModelDynamicReturnTypeExtension.php

@@ -7,6 +7,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use function count;
@@ -37,10 +38,22 @@ public function getTypeFromMethodCall(
 		$calledOnType = $scope->getType($methodCall->var);
 		$defaultType = ParametersAcceptorSelector::selectSingle($calledOnType->getMethod('createComponent', $scope)->getVariants())->getReturnType();
 		$args = $methodCall->getArgs();
-		if (count($args) !== 1) {
+		if (count($args) < 1) {
 			return $defaultType;
 		}
 
+		$throw = true;
+		if (isset($args[1])) {
+			$throwType = $scope->getType($args[1]->value);
+			if ($throwType->isTrue()->no()) {
+				$throw = false;
+			}
+		}
+
+		if ($throw) {
+			$defaultType = TypeCombinator::remove($defaultType, new NullType());
+		}
+
 		$argType = $scope->getType($args[0]->value);
 		if (count($argType->getConstantStrings()) === 0) {
 			return $defaultType;

tests/Type/Nette/data/componentModel.php

@@ -35,13 +35,19 @@ public function createComponent(string $name): AnotherControl {
 
 $someControl = new SomeControl();
 assertType('PHPStan\Type\Nette\Data\ComponentModel\SomeControl', $someControl->getComponent('some'));
-assertType('Nette\ComponentModel\IComponent|null', $someControl->getComponent('unknown'));
+assertType('Nette\ComponentModel\IComponent', $someControl->getComponent('unknown'));
+assertType('Nette\ComponentModel\IComponent|null', $someControl->getComponent('unknown', false));
+assertType('Nette\ComponentModel\IComponent', $someControl->getComponent('unknown', true));
 
 $anotherControl = new AnotherControl();
 assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $anotherControl->getComponent('another'));
 assertType('PHPStan\Type\Nette\Data\ComponentModel\SomeControl', $anotherControl->getComponent('some'));
-assertType('Nette\ComponentModel\IComponent|null', $anotherControl->getComponent('unknown'));
+assertType('Nette\ComponentModel\IComponent', $anotherControl->getComponent('unknown'));
+assertType('Nette\ComponentModel\IComponent|null', $anotherControl->getComponent('unknown', false));
+assertType('Nette\ComponentModel\IComponent', $anotherControl->getComponent('unknown', true));
 
 $overrideCreateControl = new OverrideCreateControl();
 assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('some'));
 assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('unknown'));
+assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('unknown', false));
+assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('unknown', true));

tests/Type/Nette/data/componentModelArrayAccess.php

@@ -35,12 +35,12 @@ public function createComponent(string $name): AnotherControl {
 
 $someControl = new SomeControl();
 assertType('PHPStan\Type\Nette\Data\ComponentModelArrayAccess\SomeControl', $someControl['some']);
-assertType('Nette\ComponentModel\IComponent|null', $someControl['unknown']);
+assertType('Nette\ComponentModel\IComponent', $someControl['unknown']);
 
 $anotherControl = new AnotherControl();
 assertType('PHPStan\Type\Nette\Data\ComponentModelArrayAccess\AnotherControl', $anotherControl['another']);
 assertType('PHPStan\Type\Nette\Data\ComponentModelArrayAccess\SomeControl', $anotherControl['some']);
-assertType('Nette\ComponentModel\IComponent|null', $anotherControl['unknown']);
+assertType('Nette\ComponentModel\IComponent', $anotherControl['unknown']);
 
 $overrideCreateControl = new OverrideCreateControl();
 assertType('PHPStan\Type\Nette\Data\ComponentModelArrayAccess\AnotherControl', $overrideCreateControl['some']);