Add native types to AbstractHydrator and child classes (#9353)

Author: derrabus

lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php

@@ -31,64 +31,52 @@ abstract class AbstractHydrator
 {
     /**
      * The ResultSetMapping.
-     *
-     * @var ResultSetMapping|null
      */
-    protected $_rsm;
+    protected ?ResultSetMapping $_rsm = null;
 
     /**
      * The EntityManager instance.
-     *
-     * @var EntityManagerInterface
      */
-    protected $_em;
+    protected EntityManagerInterface $_em;
 
     /**
      * The dbms Platform instance.
-     *
-     * @var AbstractPlatform
      */
-    protected $_platform;
+    protected AbstractPlatform $_platform;
 
     /**
      * The UnitOfWork of the associated EntityManager.
-     *
-     * @var UnitOfWork
      */
-    protected $_uow;
+    protected UnitOfWork $_uow;
 
     /**
      * Local ClassMetadata cache to avoid going to the EntityManager all the time.
      *
      * @var array<string, ClassMetadata<object>>
      */
-    protected $_metadataCache = [];
+    protected array $_metadataCache = [];
 
     /**
      * The cache used during row-by-row hydration.
      *
      * @var array<string, mixed[]|null>
      */
-    protected $_cache = [];
+    protected array $_cache = [];
 
     /**
      * The statement that provides the data to hydrate.
-     *
-     * @var Result|null
      */
-    protected $_stmt;
+    protected ?Result $_stmt = null;
 
     /**
      * The query hints.
      *
      * @var array<string, mixed>
      */
-    protected $_hints = [];
+    protected array $_hints = [];
 
     /**
      * Initializes a new instance of a class derived from <tt>AbstractHydrator</tt>.
-     *
-     * @param EntityManagerInterface $em The EntityManager to use.
      */
     public function __construct(EntityManagerInterface $em)
     {
@@ -166,10 +154,8 @@ final protected function resultSetMapping(): ResultSetMapping
      * Hydrates all rows returned by the passed statement instance at once.
      *
      * @psalm-param array<string, string> $hints
-     *
-     * @return mixed[]
      */
-    public function hydrateAll(Result $stmt, ResultSetMapping $resultSetMapping, array $hints = [])
+    public function hydrateAll(Result $stmt, ResultSetMapping $resultSetMapping, array $hints = []): mixed
     {
         $this->_stmt  = $stmt;
         $this->_rsm   = $resultSetMapping;
@@ -190,32 +176,24 @@ public function hydrateAll(Result $stmt, ResultSetMapping $resultSetMapping, arr
     /**
      * When executed in a hydrate() loop we have to clear internal state to
      * decrease memory consumption.
-     *
-     * @param mixed $eventArgs
-     *
-     * @return void
      */
-    public function onClear($eventArgs)
+    public function onClear(mixed $eventArgs): void
     {
     }
 
     /**
      * Executes one-time preparation tasks, once each time hydration is started
      * through {@link hydrateAll} or {@link toIterable()}.
-     *
-     * @return void
      */
-    protected function prepare()
+    protected function prepare(): void
     {
     }
 
     /**
      * Executes one-time cleanup tasks at the end of a hydration that was initiated
      * through {@link hydrateAll} or {@link toIterable()}.
-     *
-     * @return void
      */
-    protected function cleanup()
+    protected function cleanup(): void
     {
         $this->statement()->free();
 
@@ -242,21 +220,17 @@ protected function cleanupAfterRowIteration(): void
      * @param mixed[] $row    The row data.
      * @param mixed[] $result The result to fill.
      *
-     * @return void
-     *
      * @throws HydrationException
      */
-    protected function hydrateRowData(array $row, array &$result)
+    protected function hydrateRowData(array $row, array &$result): void
     {
         throw new HydrationException('hydrateRowData() not implemented by this hydrator.');
     }
 
     /**
      * Hydrates all rows from the current statement instance at once.
-     *
-     * @return mixed[]
      */
-    abstract protected function hydrateAllData();
+    abstract protected function hydrateAllData(): mixed;
 
     /**
      * Processes a row of the result set.
@@ -284,7 +258,7 @@ abstract protected function hydrateAllData();
      *                   scalars?: array
      *               }
      */
-    protected function gatherRowData(array $data, array &$id, array &$nonemptyComponents)
+    protected function gatherRowData(array $data, array &$id, array &$nonemptyComponents): array
     {
         $rowData = ['data' => []];
 
@@ -365,7 +339,7 @@ protected function gatherRowData(array $data, array &$id, array &$nonemptyCompon
      * @return mixed[] The processed row.
      * @psalm-return array<string, mixed>
      */
-    protected function gatherScalarRowData(&$data)
+    protected function gatherScalarRowData(array &$data): array
     {
         $rowData = [];
 
@@ -400,7 +374,7 @@ protected function gatherScalarRowData(&$data)
      * @return mixed[]|null
      * @psalm-return array<string, mixed>|null
      */
-    protected function hydrateColumnInfo($key)
+    protected function hydrateColumnInfo(string $key): ?array
     {
         if (isset($this->_cache[$key])) {
             return $this->_cache[$key];
@@ -508,12 +482,8 @@ function (string $subClass): string {
 
     /**
      * Retrieve ClassMetadata associated to entity class name.
-     *
-     * @param string $className
-     *
-     * @return ClassMetadata
      */
-    protected function getClassMetadata($className)
+    protected function getClassMetadata(string $className): ClassMetadata
     {
         if (! isset($this->_metadataCache[$className])) {
             $this->_metadataCache[$className] = $this->_em->getClassMetadata($className);
@@ -525,14 +495,11 @@ protected function getClassMetadata($className)
     /**
      * Register entity as managed in UnitOfWork.
      *
-     * @param object  $entity
      * @param mixed[] $data
      *
-     * @return void
-     *
      * @todo The "$id" generation is the same of UnitOfWork#createEntity. Remove this duplication somehow
      */
-    protected function registerManaged(ClassMetadata $class, $entity, array $data)
+    protected function registerManaged(ClassMetadata $class, object $entity, array $data): void
     {
         if ($class->isIdentifierComposite) {
             $id = [];

lib/Doctrine/ORM/Internal/Hydration/ArrayHydrator.php

@@ -19,27 +19,22 @@
 class ArrayHydrator extends AbstractHydrator
 {
     /** @var array<string,bool> */
-    private $_rootAliases = [];
+    private array $_rootAliases = [];
 
-    /** @var bool */
-    private $_isSimpleQuery = false;
+    private bool $_isSimpleQuery = false;
 
     /** @var mixed[] */
-    private $_identifierMap = [];
+    private array $_identifierMap = [];
 
     /** @var mixed[] */
-    private $_resultPointers = [];
+    private array $_resultPointers = [];
 
     /** @var array<string,string> */
-    private $_idTemplate = [];
+    private array $_idTemplate = [];
 
-    /** @var int */
-    private $_resultCounter = 0;
+    private int $_resultCounter = 0;
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function prepare()
+    protected function prepare(): void
     {
         $this->_isSimpleQuery = count($this->resultSetMapping()->aliasMap) <= 1;
 
@@ -53,7 +48,7 @@ protected function prepare()
     /**
      * {@inheritdoc}
      */
-    protected function hydrateAllData()
+    protected function hydrateAllData(): array
     {
         $result = [];
 
@@ -67,7 +62,7 @@ protected function hydrateAllData()
     /**
      * {@inheritdoc}
      */
-    protected function hydrateRowData(array $row, array &$result)
+    protected function hydrateRowData(array $row, array &$result): void
     {
         // 1) Initialize
         $id                 = $this->_idTemplate; // initialize the id-memory
@@ -242,13 +237,13 @@ protected function hydrateRowData(array $row, array &$result)
      * Updates the result pointer for an Entity. The result pointers point to the
      * last seen instance of each Entity type. This is used for graph construction.
      *
-     * @param mixed[]|null $coll     The element.
-     * @param bool|int     $index    Index of the element in the collection.
-     * @param bool         $oneToOne Whether it is a single-valued association or not.
+     * @param mixed[]|null     $coll     The element.
+     * @param string|int|false $index    Index of the element in the collection.
+     * @param bool             $oneToOne Whether it is a single-valued association or not.
      */
     private function updateResultPointer(
         ?array &$coll,
-        $index,
+        string|int|false $index,
         string $dqlAlias,
         bool $oneToOne
     ): void {

lib/Doctrine/ORM/Internal/Hydration/HydrationException.php

@@ -12,21 +12,12 @@
 
 class HydrationException extends Exception implements ORMException
 {
-    /**
-     * @return HydrationException
-     */
-    public static function nonUniqueResult()
+    public static function nonUniqueResult(): self
     {
         return new self('The result returned by the query was not unique.');
     }
 
-    /**
-     * @param string $alias
-     * @param string $parentAlias
-     *
-     * @return HydrationException
-     */
-    public static function parentObjectOfRelationNotFound($alias, $parentAlias)
+    public static function parentObjectOfRelationNotFound(string $alias, string $parentAlias): self
     {
         return new self(sprintf(
             "The parent object of entity result with alias '%s' was not found."
@@ -36,27 +27,15 @@ public static function parentObjectOfRelationNotFound($alias, $parentAlias)
         ));
     }
 
-    /**
-     * @param string $dqlAlias
-     *
-     * @return HydrationException
-     */
-    public static function emptyDiscriminatorValue($dqlAlias)
+    public static function emptyDiscriminatorValue(string $dqlAlias): self
     {
         return new self("The DQL alias '" . $dqlAlias . "' contains an entity " .
             'of an inheritance hierarchy with an empty discriminator value. This means ' .
             'that the database contains inconsistent data with an empty ' .
             'discriminator value in a table row.');
     }
 
-    /**
-     * @param string $entityName
-     * @param string $discrColumnName
-     * @param string $dqlAlias
-     *
-     * @return HydrationException
-     */
-    public static function missingDiscriminatorColumn($entityName, $discrColumnName, $dqlAlias)
+    public static function missingDiscriminatorColumn(string $entityName, string $discrColumnName, string $dqlAlias): self
     {
         return new self(sprintf(
             'The discriminator column "%s" is missing for "%s" using the DQL alias "%s".',
@@ -66,14 +45,7 @@ public static function missingDiscriminatorColumn($entityName, $discrColumnName,
         ));
     }
 
-    /**
-     * @param string $entityName
-     * @param string $discrColumnName
-     * @param string $dqlAlias
-     *
-     * @return HydrationException
-     */
-    public static function missingDiscriminatorMetaMappingColumn($entityName, $discrColumnName, $dqlAlias)
+    public static function missingDiscriminatorMetaMappingColumn(string $entityName, string $discrColumnName, string $dqlAlias): self
     {
         return new self(sprintf(
             'The meta mapping for the discriminator column "%s" is missing for "%s" using the DQL alias "%s".',
@@ -84,13 +56,10 @@ public static function missingDiscriminatorMetaMappingColumn($entityName, $discr
     }
 
     /**
-     * @param string   $discrValue
      * @param string[] $discrMap
      * @psalm-param array<string, string> $discrMap
-     *
-     * @return HydrationException
      */
-    public static function invalidDiscriminatorValue($discrValue, $discrMap)
+    public static function invalidDiscriminatorValue(string $discrValue, array $discrMap): self
     {
         return new self(sprintf(
             'The discriminator value "%s" is invalid. It must be one of "%s".',