Merge pull request #467 from goaop/feature/phpstan-issues-fixing

[Feature] Bump PHPStan level to 4

Author: lisachenko

phpstan.neon

@@ -1,4 +1,4 @@
 parameters:
-  level: 1
+  level: 4
   paths:
     - src

src/Aop/Framework/AbstractJoinpoint.php

@@ -34,9 +34,12 @@
 abstract class AbstractJoinpoint implements Joinpoint
 {
     /**
-     * List of advices
+     * List of advices (interceptors)
      *
-     * @var array<Advice|Interceptor>
+     * NB: All current children assume that each advice is Interceptor now.
+     * Whereas, it isn't correct logically, this can be used to satisfy PHPStan check now.
+     *
+     * @var array<Interceptor>
      */
     protected array $advices = [];
 
@@ -58,7 +61,7 @@ abstract class AbstractJoinpoint implements Joinpoint
     /**
      * Initializes list of advices for current joinpoint
      *
-     * @param array<Advice|Interceptor> $advices List of advices
+     * @param array<Interceptor> $advices List of advices (interceptors)
      */
     public function __construct(array $advices)
     {
@@ -110,11 +113,7 @@ public static function flatAndSortAdvices(array $advices): array
         $flattenAdvices = [];
         foreach ($advices as $type => $typedAdvices) {
             foreach ($typedAdvices as $name => $concreteAdvices) {
-                if (is_array($concreteAdvices)) {
-                    $flattenAdvices[$type][$name] = array_keys(self::sortAdvices($concreteAdvices));
-                } else {
-                    $flattenAdvices[$type][$name] = $concreteAdvices;
-                }
+                $flattenAdvices[$type][$name] = array_keys(self::sortAdvices($concreteAdvices));
             }
         }
 

src/Aop/Framework/ClassFieldAccess.php

@@ -15,7 +15,6 @@
 use Go\Aop\AspectException;
 use Go\Aop\Intercept\FieldAccess;
 use Go\Aop\Support\AnnotatedReflectionProperty;
-use ReflectionProperty;
 
 use function get_class;
 
@@ -32,7 +31,7 @@ final class ClassFieldAccess extends AbstractJoinpoint implements FieldAccess
     /**
      * Instance of reflection property
      */
-    protected ReflectionProperty $reflectionProperty;
+    protected AnnotatedReflectionProperty $reflectionProperty;
 
     /**
      * New value to set
@@ -80,9 +79,9 @@ public function getAccessType(): int
     /**
      * Gets the field being accessed.
      *
-     * @return AnnotatedReflectionProperty the property which is being accessed.
+     * Covariant return type is used
      */
-    public function getField(): ReflectionProperty
+    public function getField(): AnnotatedReflectionProperty
     {
         return $this->reflectionProperty;
     }

src/Aop/Pointcut/AndPointcut.php

@@ -14,6 +14,7 @@
 
 use Go\Aop\Pointcut;
 use Go\Aop\Support\AndPointFilter;
+use ReflectionClass;
 use ReflectionMethod;
 use ReflectionProperty;
 
@@ -76,11 +77,12 @@ public function getKind(): int
     /**
      * Checks if point filter matches the point
      *
-     * @param Pointcut                            $pointcut
-     * @param ReflectionMethod|ReflectionProperty $point
-     * @param mixed                               $context   Related context, can be class or namespace
-     * @param object|string|null                  $instance  [Optional] Instance for dynamic matching
-     * @param array|null                          $arguments [Optional] Extra arguments for dynamic matching
+     * @param Pointcut                                            $pointcut
+     * @param ReflectionMethod|ReflectionProperty|ReflectionClass $point
+     * @param mixed                                               $context   Related context, can be class or namespace
+     * @param object|string|null                                  $instance  [Optional] Instance for dynamic matching
+     * @param array|null                                          $arguments [Optional] Extra arguments for dynamic
+     *                                                                       matching
      *
      * @return bool
      */

src/Aop/Support/DeclareParentsAdvisor.php

@@ -14,8 +14,8 @@
 
 use Go\Aop\IntroductionAdvisor;
 use Go\Aop\IntroductionInfo;
+use Go\Aop\Pointcut;
 use Go\Aop\Pointcut\PointcutClassFilterTrait;
-use Go\Aop\PointFilter;
 
 /**
  * Introduction advisor delegating to the given object.
@@ -27,9 +27,9 @@ class DeclareParentsAdvisor extends AbstractGenericAdvisor implements Introducti
     /**
      * Creates an advisor for declaring mixins via trait and interface.
      */
-    public function __construct(PointFilter $classFilter, IntroductionInfo $info)
+    public function __construct(Pointcut $pointcut, IntroductionInfo $info)
     {
-        $this->classFilter = $classFilter;
+        $this->classFilter = $pointcut->getClassFilter();
         parent::__construct($info);
     }
 }

src/Bridge/Doctrine/MetadataLoadInterceptor.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 /*
  * Go! AOP framework
  *
@@ -9,6 +9,7 @@
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.
  */
+
 namespace Go\Bridge\Doctrine;
 
 use Doctrine\Common\EventSubscriber;
@@ -52,16 +53,13 @@ public function getSubscribedEvents(): array
      */
     public function loadClassMetadata(LoadClassMetadataEventArgs $args): void
     {
-        /**
-         * @var ClassMetadata $metadata
-         */
         $metadata = $args->getClassMetadata();
 
         if (1 === preg_match(sprintf('/.+(%s)$/', AspectContainer::AOP_PROXIED_SUFFIX), $metadata->name)) {
-            $metadata->isMappedSuperclass           = true;
-            $metadata->isEmbeddedClass              = false;
-            $metadata->table                        = [];
-            $metadata->customRepositoryClassName    = null;
+            $metadata->isMappedSuperclass        = true;
+            $metadata->isEmbeddedClass           = false;
+            $metadata->table                     = [];
+            $metadata->customRepositoryClassName = null;
 
             $this->removeMappingsFromTraits($metadata);
         }
@@ -97,10 +95,11 @@ private function removeMappingsFromTraits(ClassMetadata $metadata): void
     /**
      * Get ALL traits used by one class.
      *
-     * This method is copied from https://github.com/RunOpenCode/traitor-bundle/blob/master/src/RunOpenCode/Bundle/Traitor/Utils/ClassUtils.php
+     * This method is copied from
+     * https://github.com/RunOpenCode/traitor-bundle/blob/master/src/RunOpenCode/Bundle/Traitor/Utils/ClassUtils.php
      *
-     * @param object|string $className Instance of class or FQCN
-     * @param bool          $autoload  Weather to autoload class.
+     * @param class-string $className FQCN
+     * @param bool         $autoload  Weather to autoload class.
      *
      * @throws InvalidArgumentException
      * @throws RuntimeException
@@ -114,8 +113,9 @@ private function getTraits(string $className, bool $autoload = true): array
         $traits = [];
         // Get traits of all parent classes
         do {
-            $traits = array_merge(class_uses($className, $autoload), $traits);
-        } while ($className = get_parent_class($className));
+            $traits    = array_merge(class_uses($className, $autoload), $traits);
+            $className = get_parent_class($className);
+        } while ($className);
 
         $traitsToSearch = $traits;
 

src/Core/AbstractAspectLoaderExtension.php

@@ -17,6 +17,7 @@
 use Dissect\Lexer\TokenStream\TokenStream;
 use Dissect\Parser\Exception\UnexpectedTokenException;
 use Dissect\Parser\Parser;
+use Doctrine\Common\Annotations\Reader;
 use Go\Aop\Aspect;
 use Go\Aop\Pointcut;
 use Go\Aop\PointFilter;
@@ -39,13 +40,19 @@ abstract class AbstractAspectLoaderExtension implements AspectLoaderExtension
      */
     protected Parser $pointcutParser;
 
+    /**
+     * Instance of annotation reader
+     */
+    protected Reader $reader;
+
     /**
      * Default loader constructor that accepts pointcut lexer and parser
      */
-    public function __construct(Lexer $pointcutLexer, Parser $pointcutParser)
+    public function __construct(Lexer $pointcutLexer, Parser $pointcutParser, Reader $reader)
     {
         $this->pointcutLexer  = $pointcutLexer;
         $this->pointcutParser = $pointcutParser;
+        $this->reader         = $reader;
     }
 
     /**

src/Core/AdviceMatcher.php

@@ -49,7 +49,7 @@ public function __construct(bool $isInterceptFunctions = false)
      *
      * @param Aop\Advisor[] $advisors List of advisor to match
      *
-     * @return Aop\Advice[] List of advices for class
+     * @return Aop\Advice[][][] List of advices for function
      */
     public function getAdvicesForFunctions(ReflectionFileNamespace $namespace, array $advisors): array
     {
@@ -81,7 +81,7 @@ public function getAdvicesForFunctions(ReflectionFileNamespace $namespace, array
      *
      * @param array|Aop\Advisor[] $advisors List of advisor to match
      *
-     * @return Aop\Advice[][] List of advices for class
+     * @return Aop\Advice[][][] List of advices for class
      */
     public function getAdvicesForClass(ReflectionClass $class, array $advisors): array
     {
@@ -103,7 +103,7 @@ public function getAdvicesForClass(ReflectionClass $class, array $advisors): arr
 
             if ($advisor instanceof IntroductionAdvisor) {
                 if ($advisor->getClassFilter()->matches($class)) {
-                    $classAdvices[] = $this->getIntroductionFromAdvisor($originalClass, $advisor, $advisorId);
+                    $classAdvices[] = $this->getIntroductionFromAdvisor($originalClass, $advisor);
                 }
             }
         }
@@ -172,11 +172,12 @@ private function getAdvicesFromAdvisor(
 
     /**
      * Returns list of introduction advices from advisor
+     *
+     * @return Aop\IntroductionInfo[][][]
      */
     private function getIntroductionFromAdvisor(
         ReflectionClass $class,
-        IntroductionAdvisor $advisor,
-        string $advisorId
+        IntroductionAdvisor $advisor
     ): array {
         $classAdvices = [];
         // Do not make introduction for traits
@@ -190,13 +191,13 @@ private function getIntroductionFromAdvisor(
         if (!empty($introducedTrait)) {
             $introducedTrait = '\\' . ltrim($introducedTrait, '\\');
 
-            $classAdvices[AspectContainer::INTRODUCTION_TRAIT_PREFIX][$advisorId] = $introducedTrait;
+            $classAdvices[AspectContainer::INTRODUCTION_TRAIT_PREFIX]['root'][$introducedTrait] = $introduction;
         }
         $introducedInterface = $introduction->getInterface();
         if (!empty($introducedInterface)) {
             $introducedInterface = '\\' . ltrim($introducedInterface, '\\');
 
-            $classAdvices[AspectContainer::INTRODUCTION_INTERFACE_PREFIX][$advisorId] = $introducedInterface;
+            $classAdvices[AspectContainer::INTRODUCTION_INTERFACE_PREFIX]['root'][$introducedInterface] = $introduction;
         }
 
         return $classAdvices;

src/Core/AdviceMatcherInterface.php

@@ -1,4 +1,6 @@
 <?php
+
+declare(strict_types=1);
 /*
  * Go! AOP framework
  *
@@ -25,7 +27,7 @@ interface AdviceMatcherInterface
      *
      * @param Advisor[] $advisors List of advisor to match
      *
-     * @return Advice[][] List of advices for function
+     * @return Advice[][][] List of advices for function
      */
     public function getAdvicesForFunctions(ReflectionFileNamespace $namespace, array $advisors): array;
 
@@ -34,7 +36,7 @@ public function getAdvicesForFunctions(ReflectionFileNamespace $namespace, array
      *
      * @param Advisor[] $advisors List of advisor to match
      *
-     * @return Advice[][] List of advices for class
+     * @return Advice[][][] List of advices for class
      */
     public function getAdvicesForClass(ReflectionClass $class, array $advisors): array;
 }