Use Twig environment loader

Author: zacharylund

composer.json

@@ -36,7 +36,8 @@
     "symfony/messenger": "^5.4",
     "symfony/polyfill-php80": "^1.24",
     "symfony/serializer": "^5.4",
-    "symfony/service-contracts": "^2.2.0"
+    "symfony/service-contracts": "^2.2.0",
+    "twig/twig": "^3.0"
   },
   "config": {
     "sort-packages": true

extension.neon

@@ -11,7 +11,7 @@ parameters:
 		constantHassers: true
 		console_application_loader: null
 		consoleApplicationLoader: null
-		twigTemplateDirectories: []
+		twigEnvironmentLoader: null
 	featureToggles:
 		skipCheckGenericClasses:
 			- Symfony\Component\Form\AbstractType
@@ -116,7 +116,7 @@ parametersSchema:
 		constantHassers: bool()
 		console_application_loader: schema(string(), nullable())
 		consoleApplicationLoader: schema(string(), nullable())
-		twigTemplateDirectories: arrayOf(schema(string(), nullable()))
+		twigEnvironmentLoader: schema(string(), nullable())
 	])
 
 services:
@@ -369,8 +369,6 @@ services:
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 
 	-
-		class: PHPStan\Rules\Symfony\TwigTemplateExistsRule
+		class: PHPStan\Symfony\TwigEnvironmentResolver
 		arguments:
-			twigTemplateDirectories: %symfony.twigTemplateDirectories%
-		tags:
-			- phpstan.rules.rule
+			twigEnvironmentLoader: %symfony.twigEnvironmentLoader%

rules.neon

@@ -5,4 +5,5 @@ rules:
 	- PHPStan\Rules\Symfony\InvalidArgumentDefaultValueRule
 	- PHPStan\Rules\Symfony\UndefinedOptionRule
 	- PHPStan\Rules\Symfony\InvalidOptionDefaultValueRule
+	- PHPStan\Rules\Symfony\TwigTemplateExistsRule
 

src/Rules/Symfony/TwigTemplateExistsRule.php

@@ -2,16 +2,17 @@
 
 namespace PHPStan\Rules\Symfony;
 
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Symfony\TwigEnvironmentResolver;
+use PHPStan\Type\ObjectType;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Scalar\String_;
-use PHPStan\Analyser\Scope;
-use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\Type\ObjectType;
 use function count;
 use function file_exists;
 use function in_array;
@@ -25,13 +26,12 @@
 final class TwigTemplateExistsRule implements Rule
 {
 
-	/** @var array<string, string|null> */
-	private $twigTemplateDirectories;
+	/** @var TwigEnvironmentResolver */
+	private $twigEnvironmentResolver;
 
-	/** @param array<string, string|null> $twigTemplateDirectories */
-	public function __construct(array $twigTemplateDirectories)
+	public function __construct(TwigEnvironmentResolver $twigEnvironmentResolver)
 	{
-		$this->twigTemplateDirectories = $twigTemplateDirectories;
+		$this->twigEnvironmentResolver = $twigEnvironmentResolver;
 	}
 
 	public function getNodeType(): string
@@ -41,10 +41,6 @@ public function getNodeType(): string
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (count($this->twigTemplateDirectories) === 0) {
-			return [];
-		}
-
 		$templateArg = $this->getTwigTemplateArg($node, $scope);
 
 		if ($templateArg === null) {
@@ -70,7 +66,7 @@ public function processNode(Node $node, Scope $scope): array
 		$errors = [];
 
 		foreach ($templateNames as $templateName) {
-			if ($this->twigTemplateExists($templateName)) {
+			if ($this->twigEnvironmentResolver->templateExists($templateName)) {
 				continue;
 			}
 
@@ -107,28 +103,4 @@ private function getTwigTemplateArg(MethodCall $node, Scope $scope): ?Arg
 		return null;
 	}
 
-	private function twigTemplateExists(string $templateName): bool
-	{
-		if (preg_match('#^@(.+)\/(.+)$#', $templateName, $matches) === 1) {
-			$templateNamespace = $matches[1];
-			$templateName = $matches[2];
-		} else {
-			$templateNamespace = null;
-		}
-
-		foreach ($this->twigTemplateDirectories as $twigTemplateDirectory => $namespace) {
-			if ($namespace !== $templateNamespace) {
-				continue;
-			}
-
-			$templatePath = $twigTemplateDirectory . '/' . $templateName;
-
-			if (file_exists($templatePath)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
 }

src/Symfony/TwigEnvironmentResolver.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types=1);
+
+namespace PHPStan\Symfony;
+
+use PHPStan\ShouldNotHappenException;
+use Twig\Environment;
+use Twig\Loader\LoaderInterface;
+
+final class TwigEnvironmentResolver
+{
+
+	/** @var string|null */
+	private $twigEnvironmentLoader;
+
+	/** @var Environment|null */
+	private $twigEnvironment;
+
+	public function __construct(?string $twigEnvironmentLoader)
+	{
+		$this->twigEnvironmentLoader = $twigEnvironmentLoader;
+	}
+
+	private function getTwigEnvironment(): ?Environment
+	{
+		if ($this->twigEnvironmentLoader === null) {
+            return null;
+        }
+
+        if ($this->twigEnvironment !== null) {
+            return $this->twigEnvironment;
+        }
+
+        if (!file_exists($this->twigEnvironmentLoader)
+            || !is_readable($this->twigEnvironmentLoader)
+        ) {
+            throw new ShouldNotHappenException(sprintf('Cannot load Twig environment. Check the parameters.symfony.twigEnvironmentLoader setting in PHPStan\'s config. The offending value is "%s".', $this->twigEnvironmentLoader));
+        }
+
+        return $this->twigEnvironment = require $this->twigEnvironmentLoader;
+	}
+
+	public function templateExists(string $name): bool
+	{
+		$twigEnvironment = $this->getTwigEnvironment();
+
+		if ($twigEnvironment === null) {
+			return true;
+		}
+
+		return $twigEnvironment->getLoader()->exists($name);
+	}
+
+}

tests/Rules/Symfony/ExampleTwigController.php

@@ -61,10 +61,6 @@ public function foo(): void
 		$this->render($name);
 
 		$this->render($this->getName());
-
-		$this->render('@admin/backend.html.twig');
-		$this->render('@admin/foo.html.twig');
-		$this->render('backend.html.twig');
 	}
 
 	private function getName(): string

tests/Rules/Symfony/TwigTemplateExistsRuleMoreTemplatesTest.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Rules\Symfony;
 
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\TwigEnvironmentResolver;
 use PHPStan\Testing\RuleTestCase;
 
 /**
@@ -13,7 +14,7 @@ final class TwigTemplateExistsRuleNoTemplatesTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new TwigTemplateExistsRule([]);
+		return new TwigTemplateExistsRule(new TwigEnvironmentResolver(null));
 	}
 
 	public function testGetArgument(): void

tests/Rules/Symfony/TwigTemplateExistsRuleNoTemplatesTest.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Rules\Symfony;
 
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\TwigEnvironmentResolver;
 use PHPStan\Testing\RuleTestCase;
 
 /**
@@ -13,10 +14,7 @@ final class TwigTemplateExistsRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new TwigTemplateExistsRule([
-			__DIR__ . '/twig/templates' => null,
-			__DIR__ . '/twig/admin' => 'admin',
-		]);
+		return new TwigTemplateExistsRule(new TwigEnvironmentResolver(__DIR__ . '/twig_environment_loader.php'));
 	}
 
 	public function testGetArgument(): void
@@ -86,14 +84,6 @@ public function testGetArgument(): void
 					'Twig template "baz.html.twig" does not exist.',
 					61,
 				],
-				[
-					'Twig template "@admin/foo.html.twig" does not exist.',
-					66,
-				],
-				[
-					'Twig template "backend.html.twig" does not exist.',
-					67,
-				],
 			]
 		);
 	}