Merge pull request #126 from sascha-egerer/issue-125

TASK: Add dynamic return type extension for getIndpEnv

Author: sascha-egerer

extension.neon

@@ -89,6 +89,10 @@ services:
         class: SaschaEgerer\PhpstanTypo3\Type\MathUtilityTypeSpecifyingExtension
         tags:
             - phpstan.typeSpecifier.staticMethodTypeSpecifyingExtension
+    -
+        class: SaschaEgerer\PhpstanTypo3\Type\GeneralUtilityGetIndpEnvDynamicReturnTypeExtension
+        tags:
+            - phpstan.broker.dynamicStaticMethodReturnTypeExtension
     -
         class: SaschaEgerer\PhpstanTypo3\Stubs\StubFilesExtensionLoader
         tags:

src/Type/GeneralUtilityGetIndpEnvDynamicReturnTypeExtension.php

@@ -0,0 +1,55 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Type;
+
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\StaticCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\BooleanType;
+use PHPStan\Type\Constant\ConstantStringType;
+use PHPStan\Type\DynamicStaticMethodReturnTypeExtension;
+use PHPStan\Type\StringType;
+use PHPStan\Type\UnionType;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+class GeneralUtilityGetIndpEnvDynamicReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension
+{
+
+	public function getClass(): string
+	{
+		return GeneralUtility::class;
+	}
+
+	public function isStaticMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'getIndpEnv';
+	}
+
+	public function getTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): ?\PHPStan\Type\Type
+	{
+		$firstArgument = $methodCall->args[0];
+
+		if (!$firstArgument instanceof Arg) {
+			return null;
+		}
+
+		$argumentType = $scope->getType($firstArgument->value);
+
+		if (!$argumentType instanceof ConstantStringType) {
+			return null;
+		}
+
+		if ($argumentType->getValue() === '_ARRAY') {
+			return new ArrayType(new StringType(), new UnionType([new StringType(), new BooleanType()]));
+		}
+
+		if (in_array($argumentType->getValue(), ['TYPO3_SSL', 'TYPO3_PROXY', 'TYPO3_REV_PROXY'], true)) {
+			return new BooleanType();
+		}
+
+		return new StringType();
+	}
+
+}

tests/Unit/Type/GeneralUtilityGetIndpEnvDynamicReturnTypeExtension/GeneralUtilityGetIndpEnvDynamicReturnTypeExtensionTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Type\GeneralUtilityGetIndpEnvDynamicReturnTypeExtension;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class GeneralUtilityGetIndpEnvDynamicReturnTypeExtensionTest extends TypeInferenceTestCase
+{
+
+	/**
+	 * @return iterable<mixed>
+	 */
+	public function dataFileAsserts(): iterable
+	{
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/GeneralUtilityGetIndpEnvTest.php');
+	}
+
+	/**
+	 * @dataProvider dataFileAsserts
+	 * @param string $assertType
+	 * @param string $file
+	 * @param mixed ...$args
+	 */
+	public function testFileAsserts(
+		string $assertType,
+		string $file,
+		...$args
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../../extension.neon',
+		];
+	}
+
+}

tests/Unit/Type/GeneralUtilityGetIndpEnvDynamicReturnTypeExtension/data/GeneralUtilityGetIndpEnvTest.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Type\GeneralUtilityGetIndpEnvDynamicReturnTypeExtension\data;
+
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use function PHPStan\Testing\assertType;
+
+final class GeneralUtilityGetIndpEnvTest
+{
+
+	public function getScriptName(): void
+	{
+		$value = GeneralUtility::getIndpEnv('SCRIPT_NAME');
+		assertType('string', $value);
+	}
+
+	public function getSsl(): void
+	{
+		$value = GeneralUtility::getIndpEnv('TYPO3_SSL');
+		assertType('bool', $value);
+	}
+
+	public function getTypo3Proxy(): void
+	{
+		$value = GeneralUtility::getIndpEnv('TYPO3_PROXY');
+		assertType('bool', $value);
+	}
+
+	public function getArray(): void
+	{
+		$value = GeneralUtility::getIndpEnv('_ARRAY');
+		assertType('array<string, bool|string>', $value);
+	}
+
+}