[TwigBridge] Add types to private properties

derrabus · derrabus · commit b3724b7b4774 · 2021-09-08T11:11:59.000+02:00
Signed-off-by: Alexander M. Turek &lt;me@derrabus.de&gt;
diff --git a/AppVariable.php b/AppVariable.php
@@ -25,10 +25,10 @@
  */
 class AppVariable
 {
-    private $tokenStorage;
-    private $requestStack;
-    private $environment;
-    private $debug;
+    private TokenStorageInterface $tokenStorage;
+    private RequestStack $requestStack;
+    private string $environment;
+    private bool $debug;
 
     public function setTokenStorage(TokenStorageInterface $tokenStorage)
     {
@@ -57,11 +57,11 @@ public function setDebug(bool $debug)
      */
     public function getToken(): ?TokenInterface
     {
-        if (null === $tokenStorage = $this->tokenStorage) {
+        if (!isset($this->tokenStorage)) {
             throw new \RuntimeException('The "app.token" variable is not available.');
         }
 
-        return $tokenStorage->getToken();
+        return $this->tokenStorage->getToken();
     }
 
     /**
@@ -71,23 +71,19 @@ public function getToken(): ?TokenInterface
      */
     public function getUser(): ?UserInterface
     {
-        if (null === $tokenStorage = $this->tokenStorage) {
+        if (!isset($this->tokenStorage)) {
             throw new \RuntimeException('The "app.user" variable is not available.');
         }
 
-        if (!$token = $tokenStorage->getToken()) {
-            return null;
-        }
-
-        return $token->getUser();
+        return $this->tokenStorage->getToken()?->getUser();
     }
 
     /**
      * Returns the current request.
      */
     public function getRequest(): ?Request
     {
-        if (null === $this->requestStack) {
+        if (!isset($this->requestStack)) {
             throw new \RuntimeException('The "app.request" variable is not available.');
         }
 
@@ -99,7 +95,7 @@ public function getRequest(): ?Request
      */
     public function getSession(): ?Session
     {
-        if (null === $this->requestStack) {
+        if (!isset($this->requestStack)) {
             throw new \RuntimeException('The "app.session" variable is not available.');
         }
         $request = $this->getRequest();
@@ -112,7 +108,7 @@ public function getSession(): ?Session
      */
     public function getEnvironment(): string
     {
-        if (null === $this->environment) {
+        if (!isset($this->environment)) {
             throw new \RuntimeException('The "app.environment" variable is not available.');
         }
 
@@ -124,7 +120,7 @@ public function getEnvironment(): string
      */
     public function getDebug(): bool
     {
-        if (null === $this->debug) {
+        if (!isset($this->debug)) {
             throw new \RuntimeException('The "app.debug" variable is not available.');
         }
 
diff --git a/Command/DebugCommand.php b/Command/DebugCommand.php
@@ -35,12 +35,17 @@ class DebugCommand extends Command
     protected static $defaultName = 'debug:twig';
     protected static $defaultDescription = 'Show a list of twig functions, filters, globals and tests';
 
-    private $twig;
-    private $projectDir;
-    private $bundlesMetadata;
-    private $twigDefaultPath;
-    private $filesystemLoaders;
-    private $fileLinkFormatter;
+    private Environment $twig;
+    private ?string $projectDir;
+    private array $bundlesMetadata;
+    private ?string $twigDefaultPath;
+
+    /**
+     * @var FilesystemLoader[]
+     */
+    private array $filesystemLoaders;
+
+    private ?FileLinkFormatter $fileLinkFormatter;
 
     public function __construct(Environment $twig, string $projectDir = null, array $bundlesMetadata = [], string $twigDefaultPath = null, FileLinkFormatter $fileLinkFormatter = null)
     {
@@ -557,7 +562,7 @@ private function isAbsolutePath(string $file): bool
      */
     private function getFilesystemLoaders(): array
     {
-        if (null !== $this->filesystemLoaders) {
+        if (isset($this->filesystemLoaders)) {
             return $this->filesystemLoaders;
         }
         $this->filesystemLoaders = [];
diff --git a/Command/LintCommand.php b/Command/LintCommand.php
@@ -38,12 +38,8 @@ class LintCommand extends Command
     protected static $defaultName = 'lint:twig';
     protected static $defaultDescription = 'Lint a Twig template and outputs encountered errors';
 
-    private $twig;
-
-    /**
-     * @var string|null
-     */
-    private $format;
+    private Environment $twig;
+    private string $format;
 
     public function __construct(Environment $twig)
     {
@@ -86,11 +82,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
         $filenames = $input->getArgument('filename');
         $showDeprecations = $input->getOption('show-deprecations');
-        $this->format = $input->getOption('format');
-
-        if (null === $this->format) {
-            $this->format = GithubActionReporter::isGithubActionEnvironment() ? 'github' : 'txt';
-        }
+        $this->format = $input->getOption('format') ?? (GithubActionReporter::isGithubActionEnvironment() ? 'github' : 'txt');
 
         if (['-'] === $filenames) {
             return $this->display($input, $output, $io, [$this->validate(file_get_contents('php://stdin'), uniqid('sf_', true))]);
diff --git a/DataCollector/TwigDataCollector.php b/DataCollector/TwigDataCollector.php
@@ -28,9 +28,9 @@
  */
 class TwigDataCollector extends DataCollector implements LateDataCollectorInterface
 {
-    private $profile;
-    private $twig;
-    private $computed;
+    private Profile $profile;
+    private ?Environment $twig;
+    private array $computed;
 
     public function __construct(Profile $profile, Environment $twig = null)
     {
@@ -51,7 +51,7 @@ public function collect(Request $request, Response $response, \Throwable $except
     public function reset()
     {
         $this->profile->reset();
-        $this->computed = null;
+        unset($this->computed);
         $this->data = [];
     }
 
@@ -140,18 +140,12 @@ public function getHtmlCallGraph()
 
     public function getProfile()
     {
-        if (null === $this->profile) {
-            $this->profile = unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', 'Twig\Profiler\Profile']]);
-        }
-
-        return $this->profile;
+        return $this->profile ??= unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', 'Twig\Profiler\Profile']]);
     }
 
     private function getComputedData(string $index)
     {
-        if (null === $this->computed) {
-            $this->computed = $this->computeData($this->getProfile());
-        }
+        $this->computed ??= $this->computeData($this->getProfile());
 
         return $this->computed[$index];
     }
diff --git a/ErrorRenderer/TwigErrorRenderer.php b/ErrorRenderer/TwigErrorRenderer.php
@@ -25,9 +25,9 @@
  */
 class TwigErrorRenderer implements ErrorRendererInterface
 {
-    private $twig;
-    private $fallbackErrorRenderer;
-    private $debug;
+    private Environment $twig;
+    private HtmlErrorRenderer $fallbackErrorRenderer;
+    private \Closure|bool $debug;
 
     /**
      * @param bool|callable $debug The debugging mode as a boolean or a callable that should return it
@@ -36,7 +36,7 @@ public function __construct(Environment $twig, HtmlErrorRenderer $fallbackErrorR
     {
         $this->twig = $twig;
         $this->fallbackErrorRenderer = $fallbackErrorRenderer ?? new HtmlErrorRenderer();
-        $this->debug = $debug;
+        $this->debug = !\is_callable($debug) || $debug instanceof \Closure ? $debug : \Closure::fromCallable($debug);
     }
 
     /**
diff --git a/Extension/AssetExtension.php b/Extension/AssetExtension.php
@@ -22,7 +22,7 @@
  */
 final class AssetExtension extends AbstractExtension
 {
-    private $packages;
+    private Packages $packages;
 
     public function __construct(Packages $packages)
     {
diff --git a/Extension/CodeExtension.php b/Extension/CodeExtension.php
@@ -22,9 +22,9 @@
  */
 final class CodeExtension extends AbstractExtension
 {
-    private $fileLinkFormat;
-    private $charset;
-    private $projectDir;
+    private string|FileLinkFormatter|array|false $fileLinkFormat;
+    private string $charset;
+    private string $projectDir;
 
     public function __construct(string|FileLinkFormatter $fileLinkFormat, string $projectDir, string $charset)
     {
diff --git a/Extension/CsrfRuntime.php b/Extension/CsrfRuntime.php
@@ -19,7 +19,7 @@
  */
 final class CsrfRuntime
 {
-    private $csrfTokenManager;
+    private CsrfTokenManagerInterface $csrfTokenManager;
 
     public function __construct(CsrfTokenManagerInterface $csrfTokenManager)
     {
diff --git a/Extension/DumpExtension.php b/Extension/DumpExtension.php
@@ -26,8 +26,8 @@
  */
 final class DumpExtension extends AbstractExtension
 {
-    private $cloner;
-    private $dumper;
+    private ClonerInterface $cloner;
+    private ?HtmlDumper $dumper;
 
     public function __construct(ClonerInterface $cloner, HtmlDumper $dumper = null)
     {
diff --git a/Extension/FormExtension.php b/Extension/FormExtension.php
@@ -30,7 +30,7 @@
  */
 final class FormExtension extends AbstractExtension
 {
-    private $translator;
+    private ?TranslatorInterface $translator;
 
     public function __construct(TranslatorInterface $translator = null)
     {
diff --git a/Extension/HttpFoundationExtension.php b/Extension/HttpFoundationExtension.php
@@ -23,7 +23,7 @@
  */
 final class HttpFoundationExtension extends AbstractExtension
 {
-    private $urlHelper;
+    private UrlHelper $urlHelper;
 
     public function __construct(UrlHelper $urlHelper)
     {
diff --git a/Extension/HttpKernelRuntime.php b/Extension/HttpKernelRuntime.php
@@ -22,8 +22,8 @@
  */
 final class HttpKernelRuntime
 {
-    private $handler;
-    private $fragmentUriGenerator;
+    private FragmentHandler $handler;
+    private ?FragmentUriGeneratorInterface $fragmentUriGenerator;
 
     public function __construct(FragmentHandler $handler, FragmentUriGeneratorInterface $fragmentUriGenerator = null)
     {
diff --git a/Extension/LogoutUrlExtension.php b/Extension/LogoutUrlExtension.php
@@ -22,7 +22,7 @@
  */
 final class LogoutUrlExtension extends AbstractExtension
 {
-    private $generator;
+    private LogoutUrlGenerator $generator;
 
     public function __construct(LogoutUrlGenerator $generator)
     {
diff --git a/Extension/ProfilerExtension.php b/Extension/ProfilerExtension.php
@@ -20,8 +20,8 @@
  */
 final class ProfilerExtension extends BaseProfilerExtension
 {
-    private $stopwatch;
-    private $events;
+    private ?Stopwatch $stopwatch;
+    private \SplObjectStorage $events;
 
     public function __construct(Profile $profile, Stopwatch $stopwatch = null)
     {
diff --git a/Extension/RoutingExtension.php b/Extension/RoutingExtension.php
@@ -25,7 +25,7 @@
  */
 final class RoutingExtension extends AbstractExtension
 {
-    private $generator;
+    private UrlGeneratorInterface $generator;
 
     public function __construct(UrlGeneratorInterface $generator)
     {
diff --git a/Extension/SecurityExtension.php b/Extension/SecurityExtension.php
@@ -25,9 +25,8 @@
  */
 final class SecurityExtension extends AbstractExtension
 {
-    private $securityChecker;
-
-    private $impersonateUrlGenerator;
+    private ?AuthorizationCheckerInterface $securityChecker;
+    private ?ImpersonateUrlGenerator $impersonateUrlGenerator;
 
     public function __construct(AuthorizationCheckerInterface $securityChecker = null, ImpersonateUrlGenerator $impersonateUrlGenerator = null)
     {
diff --git a/Extension/SerializerRuntime.php b/Extension/SerializerRuntime.php
@@ -19,7 +19,7 @@
  */
 final class SerializerRuntime implements RuntimeExtensionInterface
 {
-    private $serializer;
+    private SerializerInterface $serializer;
 
     public function __construct(SerializerInterface $serializer)
     {
diff --git a/Extension/StopwatchExtension.php b/Extension/StopwatchExtension.php
@@ -23,8 +23,8 @@
  */
 final class StopwatchExtension extends AbstractExtension
 {
-    private $stopwatch;
-    private $enabled;
+    private ?Stopwatch $stopwatch;
+    private bool $enabled;
 
     public function __construct(Stopwatch $stopwatch = null, bool $enabled = true)
     {
diff --git a/Extension/TranslationExtension.php b/Extension/TranslationExtension.php
@@ -34,8 +34,8 @@ class_exists(TranslatorTrait::class);
  */
 final class TranslationExtension extends AbstractExtension
 {
-    private $translator;
-    private $translationNodeVisitor;
+    private ?TranslatorInterface $translator;
+    private ?TranslationNodeVisitor $translationNodeVisitor;
 
     public function __construct(TranslatorInterface $translator = null, TranslationNodeVisitor $translationNodeVisitor = null)
     {
diff --git a/Extension/WebLinkExtension.php b/Extension/WebLinkExtension.php
@@ -24,7 +24,7 @@
  */
 final class WebLinkExtension extends AbstractExtension
 {
-    private $requestStack;
+    private RequestStack $requestStack;
 
     public function __construct(RequestStack $requestStack)
     {
diff --git a/Extension/WorkflowExtension.php b/Extension/WorkflowExtension.php
@@ -25,7 +25,7 @@
  */
 final class WorkflowExtension extends AbstractExtension
 {
-    private $workflowRegistry;
+    private Registry $workflowRegistry;
 
     public function __construct(Registry $workflowRegistry)
     {
diff --git a/Form/TwigRendererEngine.php b/Form/TwigRendererEngine.php
diff --git a/Mime/BodyRenderer.php b/Mime/BodyRenderer.php
diff --git a/Mime/NotificationEmail.php b/Mime/NotificationEmail.php
diff --git a/Mime/TemplatedEmail.php b/Mime/TemplatedEmail.php
diff --git a/Mime/WrappedTemplatedEmail.php b/Mime/WrappedTemplatedEmail.php
diff --git a/Node/DumpNode.php b/Node/DumpNode.php
diff --git a/NodeVisitor/Scope.php b/NodeVisitor/Scope.php
diff --git a/NodeVisitor/TranslationDefaultDomainNodeVisitor.php b/NodeVisitor/TranslationDefaultDomainNodeVisitor.php
diff --git a/NodeVisitor/TranslationNodeVisitor.php b/NodeVisitor/TranslationNodeVisitor.php
diff --git a/Translation/TwigExtractor.php b/Translation/TwigExtractor.php

Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,10 @@`
`25`	`25`	`*/`
`26`	`26`	`class AppVariable`
`27`	`27`	`{`
`28`		`- private $tokenStorage;`
`29`		`- private $requestStack;`
`30`		`- private $environment;`
`31`		`- private $debug;`
	`28`	`+ private TokenStorageInterface $tokenStorage;`
	`29`	`+ private RequestStack $requestStack;`
	`30`	`+ private string $environment;`
	`31`	`+ private bool $debug;`
`32`	`32`
`33`	`33`	`public function setTokenStorage(TokenStorageInterface $tokenStorage)`
`34`	`34`	`{`
`@@ -57,11 +57,11 @@ public function setDebug(bool $debug)`
`57`	`57`	`*/`
`58`	`58`	`public function getToken(): ?TokenInterface`
`59`	`59`	`{`
`60`		`- if (null === $tokenStorage = $this->tokenStorage) {`
	`60`	`+ if (!isset($this->tokenStorage)) {`
`61`	`61`	`throw new \RuntimeException('The "app.token" variable is not available.');`
`62`	`62`	`}`
`63`	`63`
`64`		`- return $tokenStorage->getToken();`
	`64`	`+ return $this->tokenStorage->getToken();`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
`@@ -71,23 +71,19 @@ public function getToken(): ?TokenInterface`
`71`	`71`	`*/`
`72`	`72`	`public function getUser(): ?UserInterface`
`73`	`73`	`{`
`74`		`- if (null === $tokenStorage = $this->tokenStorage) {`
	`74`	`+ if (!isset($this->tokenStorage)) {`
`75`	`75`	`throw new \RuntimeException('The "app.user" variable is not available.');`
`76`	`76`	`}`
`77`	`77`
`78`		`- if (!$token = $tokenStorage->getToken()) {`
`79`		`- return null;`
`80`		`- }`
`81`		`-`
`82`		`- return $token->getUser();`
	`78`	`+ return $this->tokenStorage->getToken()?->getUser();`
`83`	`79`	`}`
`84`	`80`
`85`	`81`	`/**`
`86`	`82`	`* Returns the current request.`
`87`	`83`	`*/`
`88`	`84`	`public function getRequest(): ?Request`
`89`	`85`	`{`
`90`		`- if (null === $this->requestStack) {`
	`86`	`+ if (!isset($this->requestStack)) {`
`91`	`87`	`throw new \RuntimeException('The "app.request" variable is not available.');`
`92`	`88`	`}`
`93`	`89`
`@@ -99,7 +95,7 @@ public function getRequest(): ?Request`
`99`	`95`	`*/`
`100`	`96`	`public function getSession(): ?Session`
`101`	`97`	`{`
`102`		`- if (null === $this->requestStack) {`
	`98`	`+ if (!isset($this->requestStack)) {`
`103`	`99`	`throw new \RuntimeException('The "app.session" variable is not available.');`
`104`	`100`	`}`
`105`	`101`	`$request = $this->getRequest();`
`@@ -112,7 +108,7 @@ public function getSession(): ?Session`
`112`	`108`	`*/`
`113`	`109`	`public function getEnvironment(): string`
`114`	`110`	`{`
`115`		`- if (null === $this->environment) {`
	`111`	`+ if (!isset($this->environment)) {`
`116`	`112`	`throw new \RuntimeException('The "app.environment" variable is not available.');`
`117`	`113`	`}`
`118`	`114`
`@@ -124,7 +120,7 @@ public function getEnvironment(): string`
`124`	`120`	`*/`
`125`	`121`	`public function getDebug(): bool`
`126`	`122`	`{`
`127`		`- if (null === $this->debug) {`
	`123`	`+ if (!isset($this->debug)) {`
`128`	`124`	`throw new \RuntimeException('The "app.debug" variable is not available.');`
`129`	`125`	`}`
`130`	`126`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,9 @@`
`28`	`28`	`*/`
`29`	`29`	`class TwigDataCollector extends DataCollector implements LateDataCollectorInterface`
`30`	`30`	`{`
`31`		`- private $profile;`
`32`		`- private $twig;`
`33`		`- private $computed;`
	`31`	`+ private Profile $profile;`
	`32`	`+ private ?Environment $twig;`
	`33`	`+ private array $computed;`
`34`	`34`
`35`	`35`	`public function __construct(Profile $profile, Environment $twig = null)`
`36`	`36`	`{`
`@@ -51,7 +51,7 @@ public function collect(Request $request, Response $response, \Throwable $except`
`51`	`51`	`public function reset()`
`52`	`52`	`{`
`53`	`53`	`$this->profile->reset();`
`54`		`- $this->computed = null;`
	`54`	`+ unset($this->computed);`
`55`	`55`	`$this->data = [];`
`56`	`56`	`}`
`57`	`57`
`@@ -140,18 +140,12 @@ public function getHtmlCallGraph()`
`140`	`140`
`141`	`141`	`public function getProfile()`
`142`	`142`	`{`
`143`		`- if (null === $this->profile) {`
`144`		`- $this->profile = unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', 'Twig\Profiler\Profile']]);`
`145`		`- }`
`146`		`-`
`147`		`- return $this->profile;`
	`143`	`+ return $this->profile ??= unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', 'Twig\Profiler\Profile']]);`
`148`	`144`	`}`
`149`	`145`
`150`	`146`	`private function getComputedData(string $index)`
`151`	`147`	`{`
`152`		`- if (null === $this->computed) {`
`153`		`- $this->computed = $this->computeData($this->getProfile());`
`154`		`- }`
	`148`	`+ $this->computed ??= $this->computeData($this->getProfile());`
`155`	`149`
`156`	`150`	`return $this->computed[$index];`
`157`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,9 @@`
`25`	`25`	`*/`
`26`	`26`	`class TwigErrorRenderer implements ErrorRendererInterface`
`27`	`27`	`{`
`28`		`- private $twig;`
`29`		`- private $fallbackErrorRenderer;`
`30`		`- private $debug;`
	`28`	`+ private Environment $twig;`
	`29`	`+ private HtmlErrorRenderer $fallbackErrorRenderer;`
	`30`	`+ private \Closure\|bool $debug;`
`31`	`31`
`32`	`32`	`/**`
`33`	`33`	`* @param bool\|callable $debug The debugging mode as a boolean or a callable that should return it`
`@@ -36,7 +36,7 @@ public function __construct(Environment $twig, HtmlErrorRenderer $fallbackErrorR`
`36`	`36`	`{`
`37`	`37`	`$this->twig = $twig;`
`38`	`38`	`$this->fallbackErrorRenderer = $fallbackErrorRenderer ?? new HtmlErrorRenderer();`
`39`		`- $this->debug = $debug;`
	`39`	`+ $this->debug = !\is_callable($debug) \|\| $debug instanceof \Closure ? $debug : \Closure::fromCallable($debug);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`final class AssetExtension extends AbstractExtension`
`24`	`24`	`{`
`25`		`- private $packages;`
	`25`	`+ private Packages $packages;`
`26`	`26`
`27`	`27`	`public function __construct(Packages $packages)`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,9 @@`
`22`	`22`	`*/`
`23`	`23`	`final class CodeExtension extends AbstractExtension`
`24`	`24`	`{`
`25`		`- private $fileLinkFormat;`
`26`		`- private $charset;`
`27`		`- private $projectDir;`
	`25`	`+ private string\|FileLinkFormatter\|array\|false $fileLinkFormat;`
	`26`	`+ private string $charset;`
	`27`	`+ private string $projectDir;`
`28`	`28`
`29`	`29`	`public function __construct(string\|FileLinkFormatter $fileLinkFormat, string $projectDir, string $charset)`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*/`
`20`	`20`	`final class CsrfRuntime`
`21`	`21`	`{`
`22`		`- private $csrfTokenManager;`
	`22`	`+ private CsrfTokenManagerInterface $csrfTokenManager;`
`23`	`23`
`24`	`24`	`public function __construct(CsrfTokenManagerInterface $csrfTokenManager)`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@`
`26`	`26`	`*/`
`27`	`27`	`final class DumpExtension extends AbstractExtension`
`28`	`28`	`{`
`29`		`- private $cloner;`
`30`		`- private $dumper;`
	`29`	`+ private ClonerInterface $cloner;`
	`30`	`+ private ?HtmlDumper $dumper;`
`31`	`31`
`32`	`32`	`public function __construct(ClonerInterface $cloner, HtmlDumper $dumper = null)`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*/`
`31`	`31`	`final class FormExtension extends AbstractExtension`
`32`	`32`	`{`
`33`		`- private $translator;`
	`33`	`+ private ?TranslatorInterface $translator;`
`34`	`34`
`35`	`35`	`public function __construct(TranslatorInterface $translator = null)`
`36`	`36`	`{`