Add more missing docblocks

src/AuditManager.php

@@ -17,15 +17,22 @@
 use Doctrine\ORM\EntityManager;
 use SimpleThings\EntityAudit\EventListener\CreateSchemaListener;
 use SimpleThings\EntityAudit\EventListener\LogRevisionsListener;
+use SimpleThings\EntityAudit\Metadata\MetadataFactory;
 
 /**
  * Audit Manager grants access to metadata and configuration
  * and has a factory method for audit queries.
  */
 class AuditManager
 {
+    /**
+     * @var AuditConfiguration
+     */
     private $config;
 
+    /**
+     * @var MetadataFactory
+     */
     private $metadataFactory;
 
     public function __construct(AuditConfiguration $config)
@@ -34,11 +41,17 @@ public function __construct(AuditConfiguration $config)
         $this->metadataFactory = $config->createMetadataFactory();
     }
 
+    /**
+     * @return MetadataFactory
+     */
     public function getMetadataFactory()
     {
         return $this->metadataFactory;
     }
 
+    /**
+     * @return AuditConfiguration
+     */
     public function getConfiguration()
     {
         return $this->config;

src/AuditReader.php

@@ -67,7 +67,7 @@ class AuditReader
     /**
      * Entity cache to prevent circular references.
      *
-     * @var array
+     * @var array<string, array<string, array<int|string, object>>>
      *
      * @phpstan-var array<class-string, array<string, array<int|string, T>>>
      */
@@ -217,7 +217,7 @@ public function clearEntityCache(): void
      * @throws ORMException
      * @throws \RuntimeException
      *
-     * @return object
+     * @return object|null
      *
      * @phpstan-param class-string<T> $className
      * @phpstan-return T|null
@@ -649,11 +649,10 @@ public function diff($className, $id, $oldRevision, $newRevision)
      * @param string $className
      * @param object $entity
      *
-     * @return array
+     * @return array<string, mixed>
      *
      * @phpstan-param class-string<T> $className
      * @phpstan-param T $entity
-     * @phpstan-return array<string, mixed>
      */
     public function getEntityValues($className, $entity)
     {
@@ -678,7 +677,7 @@ public function getEntityValues($className, $entity)
      * @throws Exception
      * @throws ORMException
      *
-     * @return object[]
+     * @return array<object|null>
      *
      * @phpstan-param class-string<T> $className
      * @phpstan-return array<T|null>

src/ChangedEntity.php

@@ -21,7 +21,7 @@ class ChangedEntity
     /**
      * @var string
      *
-     * @phpstan-var class-string<T> $className
+     * @phpstan-var class-string<T>
      */
     private $className;
 
@@ -38,7 +38,7 @@ class ChangedEntity
     /**
      * @var object
      *
-     * @phpstan-var T $entity
+     * @phpstan-var T
      */
     private $entity;
 
@@ -56,6 +56,8 @@ public function __construct(string $className, array $id, string $revType, objec
 
     /**
      * @return string
+     *
+     * @phpstan-return class-string<T>
      */
     public function getClassName()
     {
@@ -80,6 +82,8 @@ public function getRevisionType()
 
     /**
      * @return object
+     *
+     * @phpstan-return T
      */
     public function getEntity()
     {

src/EventListener/CreateSchemaListener.php

@@ -46,7 +46,7 @@ public function __construct(AuditManager $auditManager)
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getSubscribedEvents()
     {

src/EventListener/LogRevisionsListener.php

@@ -96,7 +96,7 @@ public function __construct(AuditManager $auditManager)
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getSubscribedEvents()
     {
@@ -305,6 +305,9 @@ private function getOriginalEntityData(object $entity): array
         return $data;
     }
 
+    /**
+     * @return string|int
+     */
     private function getRevisionId()
     {
         if (null === $this->revisionId) {
@@ -392,9 +395,7 @@ private function getInsertRevisionSQL(ClassMetadata $class): string
     }
 
     /**
-     * @param object[] $entityData
-     *
-     * @phpstan-param array<string, object> $entityData
+     * @param array<string, object> $entityData
      */
     private function saveRevisionEntityData(ClassMetadata $class, array $entityData, string $revType): void
     {
@@ -494,7 +495,7 @@ private function getHash(object $entity): string
      * @author  Rob Caiger <[email protected]>
      * @author  Simon Mönch <[email protected]>
      *
-     * @phpstan-return array<string, array<string, mixed>>
+     * @return array<string, array<string, mixed>>
      */
     private function prepareUpdateData(EntityPersister $persister, object $entity): array
     {

src/Metadata/MetadataFactory.php

@@ -16,7 +16,9 @@
 class MetadataFactory
 {
     /**
-     * @phpstan-var array<class-string> $auditedEntities
+     * @var string[]
+     *
+     * @phpstan-var class-string[]
      */
     private $auditedEntities = [];
 
@@ -31,6 +33,8 @@ public function __construct(array $auditedEntities)
     }
 
     /**
+     * @param string $entity
+     *
      * @phpstan-param class-string $entity
      */
     public function isAudited($entity)
@@ -39,6 +43,8 @@ public function isAudited($entity)
     }
 
     /**
+     * @return array<string, string|int>
+     *
      * @phpstan-return array<class-string, string|int>
      */
     public function getAllClassNames()

src/Revision.php

@@ -45,11 +45,17 @@ public function getRev()
         return $this->rev;
     }
 
+    /**
+     * @return \DateTime
+     */
     public function getTimestamp()
     {
         return $this->timestamp;
     }
 
+    /**
+     * @return string
+     */
     public function getUsername()
     {
         return $this->username;

src/User/TokenStorageUsernameCallable.php

@@ -19,6 +19,8 @@
 class TokenStorageUsernameCallable
 {
     /**
+     * NEXT_MAJOR: Inject the required services instead of using the container.
+     *
      * @var Container
      */
     private $container;