Narrow return types for AbstractQuery::getSingleScalarResult()

phansys · phansys · commit af3071ae3d0d · 2023-05-22T21:59:17.000-03:00
diff --git a/lib/Doctrine/ORM/AbstractQuery.php b/lib/Doctrine/ORM/AbstractQuery.php
@@ -1010,7 +1010,7 @@ public function getSingleResult($hydrationMode = null)
      *
      * Alias for getSingleResult(HYDRATE_SINGLE_SCALAR).
      *
-     * @return mixed The scalar result.
+     * @return bool|float|int|string The scalar result.
      *
      * @throws NoResultException        If the query returned no result.
      * @throws NonUniqueResultException If the query result is not unique.
diff --git a/tests/Doctrine/Tests/ORM/Functional/QueryTest.php b/tests/Doctrine/Tests/ORM/Functional/QueryTest.php
@@ -486,13 +486,35 @@ public function testGetSingleResultThrowsExceptionOnNoResult(): void
     public function testGetSingleScalarResultThrowsExceptionOnNoResult(): void
     {
         $this->expectException('Doctrine\ORM\NoResultException');
-        $this->_em->createQuery('select a from Doctrine\Tests\Models\CMS\CmsArticle a')
+        $this->_em->createQuery('select a.id from Doctrine\Tests\Models\CMS\CmsArticle a')
              ->getSingleScalarResult();
     }
 
+    public function testGetSingleScalarResultThrowsExceptionOnSingleRowWithMultipleColumns(): void
+    {
+        $user           = new CmsUser();
+        $user->name     = 'Javier';
+        $user->username = 'phansys';
+        $user->status   = 'developer';
+
+        $this->_em->persist($user);
+
+        $this->_em->flush();
+        $this->_em->clear();
+
+        $this->expectException(NonUniqueResultException::class);
+        $this->expectExceptionMessage(
+            'The query returned a row containing multiple columns. Change the query or use a different result function'
+            . ' like getScalarResult().'
+        );
+
+        $this->_em->createQuery('select u from Doctrine\Tests\Models\CMS\CmsUser u')
+            ->setMaxResults(1)
+            ->getSingleScalarResult();
+    }
+
     public function testGetSingleScalarResultThrowsExceptionOnNonUniqueResult(): void
     {
-        $this->expectException('Doctrine\ORM\NonUniqueResultException');
         $user           = new CmsUser();
         $user->name     = 'Guilherme';
         $user->username = 'gblanco';
@@ -515,7 +537,12 @@ public function testGetSingleScalarResultThrowsExceptionOnNonUniqueResult(): voi
         $this->_em->flush();
         $this->_em->clear();
 
-        $this->_em->createQuery('select a from Doctrine\Tests\Models\CMS\CmsArticle a')
+        $this->expectException(NonUniqueResultException::class);
+        $this->expectExceptionMessage(
+            'The query returned multiple rows. Change the query or use a different result function like getScalarResult().'
+        );
+
+        $this->_em->createQuery('select a.id from Doctrine\Tests\Models\CMS\CmsArticle a')
              ->getSingleScalarResult();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1010,7 +1010,7 @@ public function getSingleResult($hydrationMode = null)`
`1010`	`1010`	`*`
`1011`	`1011`	`* Alias for getSingleResult(HYDRATE_SINGLE_SCALAR).`
`1012`	`1012`	`*`
`1013`		`- * @return mixed The scalar result.`
	`1013`	`+ * @return bool\|float\|int\|string The scalar result.`
`1014`	`1014`	`*`
`1015`	`1015`	`* @throws NoResultException If the query returned no result.`
`1016`	`1016`	`* @throws NonUniqueResultException If the query result is not unique.`