Symfony 6 Support for Twig Inspector

- Make typehint more accurate
- Add type hints and remove redundant phpdocs
- Fix Symfony error
- Drop unsupported php versions
- Allow Symfony 6

Author: natewiebe13

Diff for: BoxDrawings.php

@@ -14,11 +14,9 @@ class BoxDrawings
         ['┎', '─', '┖'],
     ];
 
-    /** @var int */
-    private $charsetIndex = 0;
+    private int $charsetIndex = 0;
 
-    /** @var int */
-    private $length = 0;
+    private int $length = 0;
 
     public function getStartCommentPrefix(): string
     {

Diff for: Bundle/DependencyInjection/OroTwigInspectorExtension.php

@@ -7,12 +7,15 @@
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
+/**
+ * Load bundle configuration and services.yml
+ */
 class OroTwigInspectorExtension extends Extension
 {
     /**
      * {@inheritDoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');

Diff for: Controller/OpenTemplateController.php

@@ -13,11 +13,9 @@
  */
 class OpenTemplateController
 {
-    /** @var Environment */
-    private $twig;
+    private Environment $twig;
 
-    /** @var FileLinkFormatter */
-    private $fileLinkFormatter;
+    private FileLinkFormatter $fileLinkFormatter;
 
     public function __construct(Environment $twig, FileLinkFormatter $fileLinkFormatter)
     {
@@ -26,14 +24,11 @@ public function __construct(Environment $twig, FileLinkFormatter $fileLinkFormat
     }
 
     /**
-     * @param Request $request
-     * @param string  $template
-     * @return RedirectResponse
      * @throws \Twig\Error\LoaderError
      * @throws \Twig\Error\RuntimeError
      * @throws \Twig\Error\SyntaxError
      */
-    public function __invoke(Request $request, string $template)
+    public function __invoke(Request $request, string $template): RedirectResponse
     {
         $line = $request->query->get('line', 1);
 

Diff for: DataCollector/TwigInspectorCollector.php

@@ -11,17 +11,11 @@
  */
 class TwigInspectorCollector implements DataCollectorInterface
 {
-    /**
-     * {@inheritDoc}
-     */
-    public function collect(Request $request, Response $response, \Throwable $exception = null)
+    public function collect(Request $request, Response $response, \Throwable $exception = null): void
     {
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function reset()
+    public function reset(): void
     {
     }
 

Diff for: Twig/DebugInfoNodeVisitor.php

@@ -19,18 +19,12 @@ class DebugInfoNodeVisitor extends AbstractNodeVisitor
 {
     protected const EXTENSION_NAME = HtmlCommentsExtension::class;
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function doEnterNode(Node $node, Environment $env)
+    protected function doEnterNode(Node $node, Environment $env): Node
     {
         return $node;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function doLeaveNode(Node $node, Environment $env)
+    protected function doLeaveNode(Node $node, Environment $env): Node
     {
         $varName = $this->getVarName();
         if ($node instanceof ModuleNode) {
@@ -78,18 +72,17 @@ protected function doLeaveNode(Node $node, Environment $env)
         return $node;
     }
 
-    /**
-     * @return string
-     */
-    private function getVarName()
+    private function getVarName(): string
     {
         return sprintf('__inspector_%s', hash('sha256', self::EXTENSION_NAME));
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getPriority()
+    protected function getReference(Node $node): NodeReference
+    {
+        return new NodeReference($node->getAttribute('name'), $node->getTemplateName(), $node->getTemplateLine());
+    }
+
+    public function getPriority(): int
     {
         return 0;
     }

Diff for: Twig/HtmlCommentsExtension.php

@@ -14,20 +14,15 @@ class HtmlCommentsExtension extends AbstractExtension
 {
     protected const ENABLE_FLAG_COOKIE_ID = 'twig_inspector_is_active';
 
-    /** @var string */
-    private $previousContent;
+    private ?string $previousContent = null;
 
-    /** @var int */
-    private $nestingLevel = 0;
+    private int $nestingLevel = 0;
 
-    /** @var RequestStack */
-    private $requestStack;
+    private RequestStack $requestStack;
 
-    /** @var UrlGeneratorInterface */
-    private $urlGenerator;
+    private UrlGeneratorInterface $urlGenerator;
 
-    /** @var BoxDrawings */
-    private $boxDrawings;
+    private BoxDrawings $boxDrawings;
 
     private array $skipBlocks = [];
     private bool $skipped = false;

Diff for: Twig/Node/NodeEnd.php

@@ -10,15 +10,12 @@
  */
 class NodeEnd extends Node
 {
-    /**
-     * {@inheritDoc}
-     */
-    public function __construct($varName)
+    public function __construct(string $varName)
     {
         parent::__construct([], ['var_name' => $varName]);
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler
             ->write("\n")

Diff for: Twig/Node/NodeStart.php

@@ -10,15 +10,15 @@
  */
 class NodeStart extends Node
 {
-    public function __construct($exensionName, $name, $line, $varName)
+    public function __construct(string $extensionName, string $name, int $line, string $varName)
     {
         parent::__construct(
             [],
-            ['extension_name' => $exensionName, 'name'=> $name, 'line' => $line, 'var_name' => $varName]
+            ['extension_name' => $extensionName, 'name'=> $name, 'line' => $line, 'var_name' => $varName]
         );
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler
             ->write(sprintf('$%s = $this->env->getExtension(', $this->getAttribute('var_name')))

Diff for: Twig/NodeReference.php

@@ -7,17 +7,13 @@
  */
 class NodeReference
 {
-    /** @var string */
-    private $name;
+    private string $name;
 
-    /** @var string */
-    private $template;
+    private string $template;
 
-    /** @var int */
-    private $line;
+    private int $line;
 
-    /** @var string */
-    private $id;
+    private string $id;
 
     public function __construct(string $name, string $template, int $line)
     {

Diff for: Twig/TwigInspectorExtension.php

@@ -9,10 +9,7 @@
  */
 class TwigInspectorExtension extends AbstractExtension
 {
-    /**
-     * {@inheritDoc}
-     */
-    public function getNodeVisitors()
+    public function getNodeVisitors(): array
     {
         return [new DebugInfoNodeVisitor()];
     }

Diff for: composer.json

@@ -15,12 +15,13 @@
         "psr-4": {"Oro\\TwigInspector\\": ""}
     },
     "require": {
-        "symfony/config": "^4.4.1 | ^5.0",
-        "symfony/dependency-injection": "^4.4.1 | ^5.0",
-        "symfony/http-kernel": "^4.4.13 | ^5.1.5",
-        "symfony/http-foundation": "^4.4.1 | ^5.0",
-        "symfony/routing": "^4.4.1 | ^5.0",
-        "symfony/web-profiler-bundle": "^4.4.1 | ^5.0",
+        "php": ">=7.4",
+        "symfony/config": "^4.4.1 | ^5.0 | ^6.0",
+        "symfony/dependency-injection": "^4.4.1 | ^5.0 | ^6.0",
+        "symfony/http-kernel": "^4.4.13 | ^5.1.5 | ^6.0",
+        "symfony/http-foundation": "^4.4.1 | ^5.0 | ^6.0",
+        "symfony/routing": "^4.4.1 | ^5.0 | ^6.0",
+        "symfony/web-profiler-bundle": "^4.4.1 | ^5.0 | ^6.0",
         "twig/twig": "^1.38 | ^2.7 | ^3.0"
     },
     "prefer-stable": true,