Merge pull request #22 from intaro/phpstan-level-8

phpstan up to level 8
intaro · Sep 15, 2024 · 209d359 · 209d359
2 parents 001ab69 + c1b13b2
commit 209d359
Show file tree

Hide file tree

Showing 15 changed files with 107 additions and 59 deletions.
diff --git a/Annotation/Sandbox.php b/Annotation/Sandbox.php
@@ -13,5 +13,5 @@ class Sandbox
      *
      * List of allowed types is defined in `intaro.twig_sandbox.sandbox_annotation.value_types` parameter
      */
-    public $type = 'string';
+    public string $type = 'string';
 }
diff --git a/Builder/EnvironmentBuilder.php b/Builder/EnvironmentBuilder.php
@@ -19,12 +19,17 @@
 class EnvironmentBuilder implements WarmableInterface
 {
     private LoaderInterface $loader;
-    private $options;
+    /** @var array<string, mixed> */
+    private array $options;
     private ?SecurityPolicy $policy;
-    private $rules;
+    private ?SecurityPolicyRules $rules = null;
+    /** @var AbstractExtension[] */
     private array $extensions = [];
     private DumperInterface $dumper;
 
+    /**
+     * @param array<string, mixed> $options
+     */
     public function __construct(LoaderInterface $loader, DumperInterface $dumper, SecurityPolicy $policy = null, array $options = [])
     {
         $this->loader = $loader;
@@ -44,7 +49,7 @@ public function addExtension(AbstractExtension $extension): void
     /**
      * @param AbstractExtension[]|null $extensions
      */
-    public function addExtensions(array $extensions = null): void
+    public function addExtensions(?array $extensions = null): void
     {
         if (!is_array($extensions)) {
             return;
@@ -57,8 +62,10 @@ public function addExtensions(array $extensions = null): void
 
     /**
      * Формирует окружение для Twig Sandbox
+     *
+     * @param array<string, mixed> $params
      */
-    public function getSandboxEnvironment($params = [], SecurityPolicy $securityPolicy = null): TwigAdapter
+    public function getSandboxEnvironment(array $params = [], SecurityPolicy $securityPolicy = null): TwigAdapter
     {
         $loader = new ArrayLoader();
         $twig = new Environment($loader, $params);
@@ -78,6 +85,9 @@ public function getSandboxEnvironment($params = [], SecurityPolicy $securityPoli
         return new TwigAdapter($twig);
     }
 
+    /**
+     * @param array<string, mixed> $options
+     */
     public function setOptions(array $options): void
     {
         $this->options = [
@@ -102,6 +112,9 @@ public function setOptions(array $options): void
         }
     }
 
+    /**
+     * @phpstan-assert SecurityPolicy $this->policy
+     */
     private function initSecurityPolicy(): void
     {
         $rules = $this->getPolicyRules();
@@ -114,7 +127,7 @@ private function initSecurityPolicy(): void
         $this->policy->setAllowedMethods($rules->getMethods());
     }
 
-    public function getPolicyRules()
+    public function getPolicyRules(): SecurityPolicyRules
     {
         if ($this->rules) {
             return $this->rules;
@@ -135,7 +148,7 @@ public function getPolicyRules()
             foreach ($this->options['bundles'] as $bundle) {
                 $refl = new \ReflectionClass($bundle);
 
-                $dir = dirname($refl->getFileName()) . '/Entity';
+                $dir = dirname((string) $refl->getFileName()) . '/Entity';
                 if (file_exists($dir) && is_dir($dir)) {
                     $rules->merge($this->loader->load($dir));
                 }
@@ -149,6 +162,9 @@ public function getPolicyRules()
         return $this->rules;
     }
 
+    /**
+     * @param string $cacheDir
+     */
     public function warmUp(/*string */ $cacheDir/*, ?string $buildDir = null*/)/*: array*/
     {
         $currentDir = $this->options['cache_dir'];

diff --git a/Builder/TwigAdapter.php b/Builder/TwigAdapter.php
@@ -4,6 +4,9 @@
 
 use Twig\Environment;
 
+/**
+ * @mixin Environment
+ */
 class TwigAdapter
 {
     private Environment $twigEnvironment;
@@ -13,20 +16,29 @@ public function __construct(Environment $twigEnvironment)
         $this->twigEnvironment = $twigEnvironment;
     }
 
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed
+     */
     public function __call(string $method, array $args)
     {
         if (method_exists($this, $method)) {
-            return $this->{$method(...$args)};
+            return $this->$method(...$args);
         }
 
-        return $this->twigEnvironment->{$method}(...$args);
+        return $this->twigEnvironment->$method(...$args);
     }
 
-    public function render($template, array $context = []): string
+    /**
+     * @param array<string, mixed> $context
+     */
+    public function render(string $template, array $context = []): string
     {
-        $template = $this->twigEnvironment->createTemplate($template);
-
-        return $template->render($context);
+        return $this->twigEnvironment
+            ->createTemplate($template)
+            ->render($context)
+        ;
     }
 
     public function getTwig(): Environment

diff --git a/CacheWarmer/TwigSandboxCacheWarmer.php b/CacheWarmer/TwigSandboxCacheWarmer.php
@@ -4,24 +4,22 @@
 
 use Intaro\TwigSandboxBundle\Builder\EnvironmentBuilder;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
-use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
 
 class TwigSandboxCacheWarmer implements CacheWarmerInterface
 {
-    protected $environmentBuilder;
+    protected EnvironmentBuilder $environmentBuilder;
 
     public function __construct(EnvironmentBuilder $builder)
     {
         $this->environmentBuilder = $builder;
     }
 
+    /**
+     * @param string $cacheDir
+     */
     public function warmUp(/*string */ $cacheDir/*, ?string $buildDir = null*/)/*: array*/
     {
-        if ($this->environmentBuilder instanceof WarmableInterface) {
-            return $this->environmentBuilder->warmUp($cacheDir);
-        }
-
-        return [];
+        return $this->environmentBuilder->warmUp($cacheDir);
     }
 
     public function isOptional(): bool

diff --git a/DependencyInjection/IntaroTwigSandboxExtension.php b/DependencyInjection/IntaroTwigSandboxExtension.php
@@ -15,12 +15,12 @@
 class IntaroTwigSandboxExtension extends Extension
 {
     /**
-     * {@inheritDoc}
+     * @param array<mixed> $configs
      */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
-        $config = $this->processConfiguration($configuration, $configs);
+        $this->processConfiguration($configuration, $configs);
 
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.yml');

diff --git a/Dumper/DumperInterface.php b/Dumper/DumperInterface.php
@@ -6,5 +6,5 @@
 
 interface DumperInterface
 {
-    public function dump(SecurityPolicyRules $rules);
+    public function dump(SecurityPolicyRules $rules): string;
 }
diff --git a/Dumper/PhpDumper.php b/Dumper/PhpDumper.php
@@ -6,7 +6,7 @@
 
 class PhpDumper implements DumperInterface
 {
-    public function dump(SecurityPolicyRules $rules)
+    public function dump(SecurityPolicyRules $rules): string
     {
         $result = "<?php\n";
         $result .= "return new Intaro\TwigSandboxBundle\SecurityPolicy\SecurityPolicyRules(\n";

diff --git a/Loader/AnnotationClassLoader.php b/Loader/AnnotationClassLoader.php
@@ -10,8 +10,8 @@
 
 class AnnotationClassLoader implements LoaderInterface
 {
-    protected $reader;
-    protected $annotationClass = 'Intaro\\TwigSandboxBundle\\Annotation\\Sandbox';
+    protected Reader $reader;
+    protected string $annotationClass = 'Intaro\\TwigSandboxBundle\\Annotation\\Sandbox';
 
     public function __construct(Reader $reader)
     {
@@ -23,7 +23,7 @@ public function __construct(Reader $reader)
      *
      * @param string $class A fully-qualified class name
      */
-    public function setAnnotationClass($class): void
+    public function setAnnotationClass(string $class): void
     {
         $this->annotationClass = $class;
     }
@@ -38,7 +38,7 @@ public function setAnnotationClass($class): void
      *
      * @throws \InvalidArgumentException When annotations can't be parsed
      */
-    public function load($class, $type = null)
+    public function load($class, $type = null): SecurityPolicyRules
     {
         if (!class_exists($class)) {
             throw new \InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
@@ -50,7 +50,7 @@ public function load($class, $type = null)
         }
 
         $rules = new SecurityPolicyRules();
-        $rules->addResource(new FileResource($class->getFileName()));
+        $rules->addResource(new FileResource((string) $class->getFileName()));
 
         foreach ($class->getMethods() as $method) {
             foreach ($this->reader->getMethodAnnotations($method) as $annot) {
@@ -73,7 +73,7 @@ public function load($class, $type = null)
     }
 
     /**
-     * {@inheritdoc}
+     * @param ?string $type
      */
     public function supports($resource, $type = null): bool
     {

diff --git a/Loader/AnnotationDirectoryLoader.php b/Loader/AnnotationDirectoryLoader.php
@@ -10,14 +10,14 @@ class AnnotationDirectoryLoader extends AnnotationFileLoader
     /**
      * Loads from annotations from a directory.
      *
-     * @param string $path A directory path
-     * @param string $type The resource type
+     * @param string  $path A directory path
+     * @param ?string $type The resource type
      *
      * @return SecurityPolicyRules A Rules instance
      *
      * @throws \InvalidArgumentException When annotations can't be parsed
      */
-    public function load($path, $type = null)
+    public function load($path, $type = null): SecurityPolicyRules
     {
         $dir = $this->locator->locate($path);
 
@@ -47,7 +47,7 @@ public function load($path, $type = null)
     }
 
     /**
-     * {@inheritdoc}
+     * @param ?string $type
      */
     public function supports($resource, $type = null): bool
     {

diff --git a/Loader/AnnotationFileLoader.php b/Loader/AnnotationFileLoader.php
@@ -9,7 +9,7 @@
 
 class AnnotationFileLoader extends FileLoader
 {
-    protected $loader;
+    protected AnnotationClassLoader $loader;
 
     /**
      * Constructor.
@@ -31,14 +31,14 @@ public function __construct(FileLocator $locator, AnnotationClassLoader $loader,
     /**
      * Loads from annotations from a file.
      *
-     * @param string $file A PHP file path
-     * @param string $type The resource type
+     * @param string  $file A PHP file path
+     * @param ?string $type The resource type
      *
      * @return SecurityPolicyRules A Rules instance
      *
      * @throws \InvalidArgumentException When annotations can't be parsed
      */
-    public function load($file, $type = null)
+    public function load($file, $type = null): SecurityPolicyRules
     {
         $path = $this->locator->locate($file);
 
@@ -52,7 +52,7 @@ public function load($file, $type = null)
     }
 
     /**
-     * {@inheritdoc}
+     * @param ?string $type
      */
     public function supports($resource, $type = null): bool
     {
@@ -64,13 +64,13 @@ public function supports($resource, $type = null): bool
      *
      * @param string $file A PHP file path
      *
-     * @return string|false Full class name if found, false otherwise
+     * @return class-string|false Full class name if found, false otherwise
      */
     protected function findClass(string $file)
     {
         $class = false;
         $namespace = false;
-        $tokens = token_get_all(file_get_contents($file));
+        $tokens = token_get_all((string) file_get_contents($file));
 
         if (1 === \count($tokens) && \T_INLINE_HTML === $tokens[0][0]) {
             throw new \InvalidArgumentException(sprintf('The file "%s" does not contain PHP code. Did you forgot to add the "<?php" start tag at the beginning of the file?', $file));
@@ -89,7 +89,10 @@ protected function findClass(string $file)
             }
 
             if (true === $class && \T_STRING === $token[0]) {
-                return $namespace . '\\' . $token[1];
+                /** @var class-string $r */
+                $r = $namespace . '\\' . $token[1];
+
+                return $r;
             }
 
             if (true === $namespace && isset($nsTokens[$token[0]])) {