Merge pull request #8548 from orklah/test2

Adding details to types in PHPDoc
doctrine · Apr 18, 2021 · b04d7a6 · b04d7a6
2 parents ce128e7 + dc37c2c
commit b04d7a6
Show file tree

Hide file tree

Showing 57 changed files with 311 additions and 154 deletions.
diff --git a/lib/Doctrine/ORM/AbstractQuery.php b/lib/Doctrine/ORM/AbstractQuery.php
@@ -312,6 +312,7 @@ public function free()
      * Get all defined parameters.
      *
      * @return ArrayCollection The defined query parameters.
+     * @psalm-return ArrayCollection<int, Parameter>
      */
     public function getParameters()
     {
@@ -323,7 +324,7 @@ public function getParameters()
      *
      * @param mixed $key The key (index or name) of the bound parameter.
      *
-     * @return Query\Parameter|null The value of the bound parameter, or NULL if not available.
+     * @return Parameter|null The value of the bound parameter, or NULL if not available.
      */
     public function getParameter($key)
     {

diff --git a/lib/Doctrine/ORM/Cache/CacheConfiguration.php b/lib/Doctrine/ORM/Cache/CacheConfiguration.php
@@ -63,6 +63,9 @@ public function getCacheLogger()
          return $this->cacheLogger;
     }
 
+    /**
+     * @return void
+     */
     public function setCacheLogger(CacheLogger $logger)
     {
         $this->cacheLogger = $logger;
@@ -80,6 +83,9 @@ public function getRegionsConfiguration()
         return $this->regionsConfig;
     }
 
+    /**
+     * @return void
+     */
     public function setRegionsConfiguration(RegionsConfiguration $regionsConfig)
     {
         $this->regionsConfig = $regionsConfig;
@@ -99,6 +105,9 @@ public function getQueryValidator()
          return $this->queryValidator;
     }
 
+    /**
+     * @return void
+     */
     public function setQueryValidator(QueryCacheValidator $validator)
     {
         $this->queryValidator = $validator;

diff --git a/lib/Doctrine/ORM/Cache/DefaultCacheFactory.php b/lib/Doctrine/ORM/Cache/DefaultCacheFactory.php
@@ -70,6 +70,8 @@ public function __construct(RegionsConfiguration $cacheConfig, CacheAdapter $cac
 
     /**
      * @param string $fileLockRegionDirectory
+     *
+     * @return void
      */
     public function setFileLockRegionDirectory($fileLockRegionDirectory)
     {
@@ -84,11 +86,17 @@ public function getFileLockRegionDirectory()
         return $this->fileLockRegionDirectory;
     }
 
+    /**
+     * @return void
+     */
     public function setRegion(Region $region)
     {
         $this->regions[$region->getName()] = $region;
     }
 
+    /**
+     * @return void
+     */
     public function setTimestampRegion(TimestampRegion $region)
     {
         $this->timestampRegion = $region;

diff --git a/lib/Doctrine/ORM/Cache/DefaultQueryCache.php b/lib/Doctrine/ORM/Cache/DefaultQueryCache.php
@@ -345,7 +345,7 @@ public function put(QueryCacheKey $key, ResultSetMapping $rsm, $result, array $h
      * @param mixed               $assocValue
      *
      * @return mixed[]|null
-     * @psalm-return array{targetEntity: string, type: mixed, list?: array[], identifier?: array}|null
+     * @psalm-return array{targetEntity: class-string, type: mixed, list?: array[], identifier?: array}|null
      */
     private function storeAssociationCache(QueryCacheKey $key, array $assoc, $assocValue)
     {

diff --git a/lib/Doctrine/ORM/Cache/Logging/CacheLoggerChain.php b/lib/Doctrine/ORM/Cache/Logging/CacheLoggerChain.php
@@ -34,6 +34,8 @@ class CacheLoggerChain implements CacheLogger
 
     /**
      * @param string $name
+     *
+     * @return void
      */
     public function setLogger($name, CacheLogger $logger)
     {

diff --git a/lib/Doctrine/ORM/Cache/Logging/StatisticsCacheLogger.php b/lib/Doctrine/ORM/Cache/Logging/StatisticsCacheLogger.php
@@ -194,6 +194,8 @@ public function getRegionsPut()
      * Clear region statistics
      *
      * @param string $regionName The name of the cache region.
+     *
+     * @return void
      */
     public function clearRegionStats($regionName)
     {
@@ -204,6 +206,8 @@ public function clearRegionStats($regionName)
 
     /**
      * Clear all statistics
+     *
+     * @return void
      */
     public function clearStats()
     {

diff --git a/lib/Doctrine/ORM/Cache/Persister/Collection/AbstractCollectionPersister.php b/lib/Doctrine/ORM/Cache/Persister/Collection/AbstractCollectionPersister.php
@@ -239,6 +239,8 @@ public function loadCriteria(PersistentCollection $collection, Criteria $criteri
 
     /**
      * Clears cache entries related to the current collection
+     *
+     * @return void
      */
     protected function evictCollectionCache(PersistentCollection $collection)
     {
@@ -258,6 +260,8 @@ protected function evictCollectionCache(PersistentCollection $collection)
     /**
      * @param string $targetEntity
      * @param object $element
+     *
+     * @return void
      */
     protected function evictElementCache($targetEntity, $element)
     {

diff --git a/lib/Doctrine/ORM/Cache/Persister/Entity/AbstractEntityPersister.php b/lib/Doctrine/ORM/Cache/Persister/Entity/AbstractEntityPersister.php
@@ -225,6 +225,8 @@ public function storeEntityCache($entity, EntityCacheKey $key)
 
     /**
      * @param object $entity
+     *
+     * @return void
      */
     private function storeJoinedAssociations($entity)
     {

diff --git a/lib/Doctrine/ORM/Cache/Region/FileLockRegion.php b/lib/Doctrine/ORM/Cache/Region/FileLockRegion.php
@@ -128,7 +128,7 @@ private function getLockFileName(CacheKey $key)
     /**
      * @param string $filename
      *
-     * @return string
+     * @return false|string
      */
     private function getLockContent($filename)
     {
@@ -138,7 +138,7 @@ private function getLockContent($filename)
     /**
      * @param string $filename
      *
-     * @return int
+     * @return false|int
      */
     private function getLockTime($filename)
     {

diff --git a/lib/Doctrine/ORM/Cache/RegionsConfiguration.php b/lib/Doctrine/ORM/Cache/RegionsConfiguration.php
@@ -57,6 +57,8 @@ public function getDefaultLifetime()
 
     /**
      * @param int $defaultLifetime
+     *
+     * @return void
      */
     public function setDefaultLifetime($defaultLifetime)
     {
@@ -73,6 +75,8 @@ public function getDefaultLockLifetime()
 
     /**
      * @param int $defaultLockLifetime
+     *
+     * @return void
      */
     public function setDefaultLockLifetime($defaultLockLifetime)
     {
@@ -92,6 +96,8 @@ public function getLifetime($regionName)
     /**
      * @param string $name
      * @param int    $lifetime
+     *
+     * @return void
      */
     public function setLifetime($name, $lifetime)
     {
@@ -111,6 +117,8 @@ public function getLockLifetime($regionName)
     /**
      * @param string $name
      * @param int    $lifetime
+     *
+     * @return void
      */
     public function setLockLifetime($name, $lifetime)
     {

diff --git a/lib/Doctrine/ORM/Configuration.php b/lib/Doctrine/ORM/Configuration.php
@@ -632,6 +632,8 @@ public function getClassMetadataFactoryName()
      *
      * @param string $name      The name of the filter.
      * @param string $className The class name of the filter.
+     *
+     * @return void
      */
     public function addFilter($name, $className)
     {
@@ -733,6 +735,8 @@ public function getQuoteStrategy()
 
     /**
      * Set the entity listener resolver.
+     *
+     * @return void
      */
     public function setEntityListenerResolver(EntityListenerResolver $resolver)
     {
@@ -755,6 +759,8 @@ public function getEntityListenerResolver()
 
     /**
      * Set the entity repository factory.
+     *
+     * @return void
      */
     public function setRepositoryFactory(RepositoryFactory $repositoryFactory)
     {
@@ -823,6 +829,8 @@ public function getDefaultQueryHints()
      * Sets array of query hints, which will be applied to every query in application
      *
      * @psalm-param array<string, mixed> $defaultQueryHints
+     *
+     * @return void
      */
     public function setDefaultQueryHints(array $defaultQueryHints)
     {
@@ -846,6 +854,8 @@ public function getDefaultQueryHint($name)
      *
      * @param string $name  The name of the hint.
      * @param mixed  $value The value of the hint.
+     *
+     * @return void
      */
     public function setDefaultQueryHint($name, $value)
     {

diff --git a/lib/Doctrine/ORM/EntityRepository.php b/lib/Doctrine/ORM/EntityRepository.php
@@ -315,6 +315,7 @@ protected function getClassMetadata()
      * Select all elements from a selectable that match the expression and
      * return a new collection containing these elements.
      *
+     * @return LazyCriteriaCollection
      * @psalm-return Collection<int, T>
      */
     public function matching(Criteria $criteria)

diff --git a/lib/Doctrine/ORM/Event/ListenersInvoker.php b/lib/Doctrine/ORM/Event/ListenersInvoker.php
@@ -90,6 +90,8 @@ public function getSubscribedSystems(ClassMetadata $metadata, $eventName)
      * @param object        $entity    The Entity on which the event occurred.
      * @param EventArgs     $event     The Event args.
      * @param int           $invoke    Bitmask to invoke listeners.
+     *
+     * @return void
      */
     public function invoke(ClassMetadata $metadata, $eventName, $entity, EventArgs $event, $invoke)
     {

diff --git a/lib/Doctrine/ORM/Event/OnClassMetadataNotFoundEventArgs.php b/lib/Doctrine/ORM/Event/OnClassMetadataNotFoundEventArgs.php
@@ -48,6 +48,9 @@ public function __construct($className, ObjectManager $objectManager)
         parent::__construct($objectManager);
     }
 
+    /**
+     * @return void
+     */
     public function setFoundMetadata(?ClassMetadata $classMetadata = null)
     {
         $this->foundMetadata = $classMetadata;

diff --git a/lib/Doctrine/ORM/Event/OnClearEventArgs.php b/lib/Doctrine/ORM/Event/OnClearEventArgs.php
@@ -21,7 +21,6 @@
 namespace Doctrine\ORM\Event;
 
 use Doctrine\Common\EventArgs;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
 
 /**
@@ -49,7 +48,7 @@ public function __construct(EntityManagerInterface $em, $entityClass = null)
     /**
      * Retrieves associated EntityManager.
      *
-     * @return EntityManager
+     * @return EntityManagerInterface
      */
     public function getEntityManager()
     {

diff --git a/lib/Doctrine/ORM/Event/OnFlushEventArgs.php b/lib/Doctrine/ORM/Event/OnFlushEventArgs.php
@@ -21,7 +21,6 @@
 namespace Doctrine\ORM\Event;
 
 use Doctrine\Common\EventArgs;
-use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
 
 /**
@@ -42,7 +41,7 @@ public function __construct(EntityManagerInterface $em)
     /**
      * Retrieve associated EntityManager.
      *
-     * @return EntityManager
+     * @return EntityManagerInterface
      */
     public function getEntityManager()
     {

diff --git a/lib/Doctrine/ORM/Internal/CommitOrderCalculator.php b/lib/Doctrine/ORM/Internal/CommitOrderCalculator.php
@@ -148,6 +148,8 @@ public function sort()
      * {@internal Highly performance-sensitive method.}
      *
      * @param stdClass $vertex
+     *
+     * @return void
      */
     private function visit($vertex)
     {

diff --git a/lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php b/lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php
@@ -31,6 +31,7 @@
 use Doctrine\ORM\Query\ResultSetMapping;
 use Doctrine\ORM\Tools\Pagination\LimitSubqueryWalker;
 use Doctrine\ORM\UnitOfWork;
+use Generator;
 use PDO;
 use ReflectionClass;
 
@@ -152,7 +153,7 @@ public function iterate($stmt, $resultSetMapping, array $hints = [])
      *
      * @psalm-param array<string, mixed> $hints
      *
-     * @return iterable<mixed>
+     * @return Generator<int, mixed>
      */
     public function toIterable(ResultStatement $stmt, ResultSetMapping $resultSetMapping, array $hints = []): iterable
     {
@@ -220,7 +221,7 @@ public function hydrateAll($stmt, $resultSetMapping, array $hints = [])
      * Hydrates a single row returned by the current statement instance during
      * row-by-row hydration with {@link iterate()} or {@link toIterable()}.
      *
-     * @return mixed
+     * @return mixed[]|false
      */
     public function hydrateRow()
     {
@@ -539,6 +540,7 @@ protected function hydrateColumnInfo($key)
 
     /**
      * @return string[]
+     * @psalm-return non-empty-list<string>
      */
     private function getDiscriminatorValues(ClassMetadata $classMetadata): array
     {

diff --git a/lib/Doctrine/ORM/Internal/HydrationCompleteHandler.php b/lib/Doctrine/ORM/Internal/HydrationCompleteHandler.php
@@ -54,6 +54,8 @@ public function __construct(ListenersInvoker $listenersInvoker, EntityManagerInt
      * Method schedules invoking of postLoad entity to the very end of current hydration cycle.
      *
      * @param object $entity
+     *
+     * @return void
      */
     public function deferPostLoadInvoking(ClassMetadata $class, $entity)
     {
@@ -70,6 +72,8 @@ public function deferPostLoadInvoking(ClassMetadata $class, $entity)
      * This method should me called after any hydration cycle completed.
      *
      * Method fires all deferred invocations of postLoad events
+     *
+     * @return void
      */
     public function hydrationComplete()
     {

diff --git a/lib/Doctrine/ORM/Mapping/Builder/ClassMetadataBuilder.php b/lib/Doctrine/ORM/Mapping/Builder/ClassMetadataBuilder.php
@@ -39,7 +39,7 @@ public function __construct(ClassMetadataInfo $cm)
     }
 
     /**
-     * @return ClassMetadata
+     * @return ClassMetadataInfo
      */
     public function getClassMetadata()
     {

diff --git a/lib/Doctrine/ORM/Mapping/Builder/EntityListenerBuilder.php b/lib/Doctrine/ORM/Mapping/Builder/EntityListenerBuilder.php
@@ -50,6 +50,8 @@ class EntityListenerBuilder
      * @param ClassMetadata $metadata  The entity metadata.
      * @param string        $className The listener class name.
      *
+     * @return void
+     *
      * @throws MappingException When the listener class not found.
      */
     public static function bindEntityListener(ClassMetadata $metadata, $className)