Fixed PHPStan feedbacks (#47)

DamienHarper · Sep 26, 2021 · 6843e88 · 6843e88
1 parent f57ad98
commit 6843e88
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 13 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -20,7 +20,8 @@ parameters:
         - '~Parameter \#2 \$eventName of method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface\:\:dispatch\(\) expects string\|null, DH\\Auditor\\Event\\LifecycleEvent given\.~'
         - '~Cannot call method setFetchMode\(\) on Doctrine\\DBAL\\ForwardCompatibility\\DriverStatement\|int~'
         - '~Cannot call method fetchAll\(\) on Doctrine\\DBAL\\ForwardCompatibility\\DriverStatement\|int~'
-        - '~Parameter \#1 \$keep of method DH\\Auditor\\Provider\\Doctrine\\Persistence\\Command\\CleanAuditLogsCommand\:\:validateKeepArgument\(\) expects string, string\|null given~'
         - '~Method DH\\Auditor\\Provider\\Doctrine\\Persistence\\Reader\\Filter\\RangeFilter\:\:__construct\(\) has parameter \$minValue with no typehint specified~'
         - '~Method DH\\Auditor\\Provider\\Doctrine\\Persistence\\Reader\\Filter\\RangeFilter\:\:__construct\(\) has parameter \$maxValue with no typehint specified~'
         - '~Method DH\\Auditor\\Provider\\Doctrine\\Persistence\\Reader\\Filter\\\SimpleFilter\:\:__construct\(\) has parameter \$value with no typehint specified.~'
+        - '~Call to an undefined method ReflectionClass\<object\>\:\:getAttributes\(\)\.~'
+        - '~Call to an undefined method ReflectionProperty\:\:getAttributes\(\)\.~'
diff --git a/src/Provider/Doctrine/Auditing/Annotation/AnnotationLoader.php b/src/Provider/Doctrine/Auditing/Annotation/AnnotationLoader.php
@@ -10,7 +10,7 @@
 class AnnotationLoader
 {
     /**
-     * @var AnnotationReader
+     * @var null|AnnotationReader
      */
     private $reader;
 
@@ -42,14 +42,19 @@ public function load(): array
 
     private function getEntityConfiguration(ClassMetadata $metadata): ?array
     {
+        $annotation = null;
+        $auditableAnnotation = null;
+        $securityAnnotation = null;
+        $annotationProperty = null;
         $reflection = $metadata->getReflectionClass();
 
         // Check that we have an Entity annotation
         if (\PHP_VERSION_ID >= 80000 && $attributes = $reflection->getAttributes(Entity::class)) {
             $annotation = $attributes[0]->newInstance();
-        } else {
+        } elseif (null !== $this->reader) {
             $annotation = $this->reader->getClassAnnotation($reflection, Entity::class);
         }
+
         if (null === $annotation) {
             return null;
         }
@@ -58,10 +63,11 @@ private function getEntityConfiguration(ClassMetadata $metadata): ?array
         if (\PHP_VERSION_ID >= 80000 && $attributes = $reflection->getAttributes(Auditable::class)) {
             /** @var ?Auditable $auditableAnnotation */
             $auditableAnnotation = $attributes[0]->newInstance();
-        } else {
+        } elseif (null !== $this->reader) {
             /** @var ?Auditable $auditableAnnotation */
             $auditableAnnotation = $this->reader->getClassAnnotation($reflection, Auditable::class);
         }
+
         if (null === $auditableAnnotation) {
             return null;
         }
@@ -70,10 +76,11 @@ private function getEntityConfiguration(ClassMetadata $metadata): ?array
         if (\PHP_VERSION_ID >= 80000 && $attributes = $reflection->getAttributes(Security::class)) {
             /** @var ?Security $securityAnnotation */
             $securityAnnotation = $attributes[0]->newInstance();
-        } else {
+        } elseif (null !== $this->reader) {
             /** @var ?Security $securityAnnotation */
             $securityAnnotation = $this->reader->getClassAnnotation($reflection, Security::class);
         }
+
         if (null === $securityAnnotation) {
             $roles = null;
         } else {
@@ -96,7 +103,7 @@ private function getEntityConfiguration(ClassMetadata $metadata): ?array
                 $annotationProperty = $this->reader->getPropertyAnnotation($property, Ignore::class);
             }
 
-            if ($annotationProperty) {
+            if (null !== $annotationProperty) {
                 // TODO: $property->getName() might not be the column name
                 $config['ignored_columns'][] = $property->getName();
             }

diff --git a/src/Provider/Doctrine/Auditing/Annotation/Auditable.php b/src/Provider/Doctrine/Auditing/Annotation/Auditable.php
@@ -8,7 +8,7 @@
 
 /**
  * @Annotation
- * @NamedArgumentConstructor()
+ * @NamedArgumentConstructor
  * @Target("CLASS")
  * @Attributes({
  *     @Attribute("enabled", required=false, type="bool"),

diff --git a/src/Provider/Doctrine/Auditing/Annotation/Security.php b/src/Provider/Doctrine/Auditing/Annotation/Security.php
@@ -9,7 +9,7 @@
 
 /**
  * @Annotation
- * @NamedArgumentConstructor()
+ * @NamedArgumentConstructor
  * @Target("CLASS")
  * @Attributes({
  *     @Attribute("view", required=true, type="array<string>"),
@@ -21,7 +21,7 @@ final class Security
     public const VIEW_SCOPE = 'view';
 
     /**
-     * @var string
+     * @var array
      * @Required
      */
     public $view;

diff --git a/src/Provider/Doctrine/Auditing/Logger/Logger.php b/src/Provider/Doctrine/Auditing/Logger/Logger.php
@@ -27,7 +27,7 @@ public function startQuery($sql, ?array $params = null, ?array $types = null): v
         }
         // on rollback remove flusher callback
         if ('"ROLLBACK"' === $sql) {
-            $this->flusher = static function(){};
+            $this->flusher = static function (): void {};
         }
     }
 

diff --git a/src/Provider/Doctrine/Auditing/Transaction/TransactionHydrator.php b/src/Provider/Doctrine/Auditing/Transaction/TransactionHydrator.php
@@ -80,7 +80,9 @@ private function hydrateWithScheduledCollectionUpdates(Transaction $transaction,
         $uow = $entityManager->getUnitOfWork();
         /** @var PersistentCollection $collection */
         foreach (array_reverse($uow->getScheduledCollectionUpdates()) as $collection) {
-            if ($this->provider->isAudited($collection->getOwner())) {
+            /** @var object $owner */
+            $owner = $collection->getOwner();
+            if ($this->provider->isAudited($owner)) {
                 $mapping = $collection->getMapping();
                 foreach ($collection->getInsertDiff() as $entity) {
                     if ($this->provider->isAudited($entity)) {
@@ -110,7 +112,9 @@ private function hydrateWithScheduledCollectionDeletions(Transaction $transactio
         $uow = $entityManager->getUnitOfWork();
         /** @var PersistentCollection $collection */
         foreach (array_reverse($uow->getScheduledCollectionDeletions()) as $collection) {
-            if ($this->provider->isAudited($collection->getOwner())) {
+            /** @var object $owner */
+            $owner = $collection->getOwner();
+            if ($this->provider->isAudited($owner)) {
                 $mapping = $collection->getMapping();
                 foreach ($collection->toArray() as $entity) {
                     if ($this->provider->isAudited($entity)) {

diff --git a/src/Security/RoleCheckerInterface.php b/src/Security/RoleCheckerInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace  DH\Auditor\Security;
+namespace DH\Auditor\Security;
 
 interface RoleCheckerInterface
 {