[TASK] Make return types of repositories more strict

TYPO3GmbH · May 22, 2023 · dec9d38 · dec9d38
1 parent c61fb3f
commit dec9d38
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 73 deletions.
diff --git a/Classes/Domain/Model/Post.php b/Classes/Domain/Model/Post.php
@@ -18,6 +18,7 @@
 use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
 use TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder;
 use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
 class Post extends AbstractEntity
 {
@@ -236,10 +237,7 @@ public function getComments(): ObjectStorage
         return $this->comments;
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function getActiveComments()
+    public function getActiveComments(): QueryResultInterface
     {
         return GeneralUtility::makeInstance(CommentRepository::class)
             ->findAllByPost($this);

diff --git a/Classes/Domain/Repository/CategoryRepository.php b/Classes/Domain/Repository/CategoryRepository.php
@@ -16,6 +16,7 @@
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 use TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings;
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 use TYPO3\CMS\Extbase\Persistence\Repository;
 
 class CategoryRepository extends Repository
@@ -41,21 +42,15 @@ public function initializeObject(): void
         ];
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findByUids(array $uids)
+    public function findByUids(array $uids): QueryResultInterface
     {
         $query = $this->createQuery();
         $query->matching($query->in('uid', $uids));
 
         return $query->execute();
     }
 
-    /**
-     * @return array|null|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function getByReference(string $table, int $uid, string $field = 'categories')
+    public function getByReference(string $table, int $uid, string $field = 'categories'): ?QueryResultInterface
     {
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
         $queryBuilder = $connectionPool->getConnectionForTable('sys_category_record_mm')->createQueryBuilder();

diff --git a/Classes/Domain/Repository/CommentRepository.php b/Classes/Domain/Repository/CommentRepository.php
@@ -19,6 +19,7 @@
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 use TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings;
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 use TYPO3\CMS\Extbase\Persistence\Repository;
 
 class CommentRepository extends Repository
@@ -43,10 +44,7 @@ public function initializeObject(): void
         ];
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllByPost(Post $post)
+    public function findAllByPost(Post $post): QueryResultInterface
     {
         $query = $this->createQuery();
         $constraints = [];
@@ -58,10 +56,7 @@ public function findAllByPost(Post $post)
         return $result;
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllByFilter(string $filter = null, int $blogSetup = null)
+    public function findAllByFilter(string $filter = null, int $blogSetup = null): QueryResultInterface
     {
         $query = $this->createQuery();
         $querySettings = $query->getQuerySettings();
@@ -95,13 +90,10 @@ public function findAllByFilter(string $filter = null, int $blogSetup = null)
             return $query->matching($query->logicalAnd(...$constraints))->execute();
         }
 
-        return $this->findAll();
+        return $this->createQuery()->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findActiveComments(int $limit = null, int $blogSetup = null)
+    public function findActiveComments(int $limit = null, int $blogSetup = null): QueryResultInterface
     {
         $query = $this->createQuery();
 

diff --git a/Classes/Domain/Repository/PostRepository.php b/Classes/Domain/Repository/PostRepository.php
@@ -28,6 +28,7 @@
 use TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings;
 use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 use TYPO3\CMS\Extbase\Persistence\Repository;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
@@ -139,18 +140,12 @@ public function findByRepositoryDemand(PostRepositoryDemand $repositoryDemand):
         return $result;
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAll()
+    public function findAll(): QueryResultInterface
     {
         return $this->getFindAllQuery()->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllByPid(?int $blogSetup = null)
+    public function findAllByPid(?int $blogSetup = null): QueryResultInterface
     {
         $query = $this->getFindAllQuery();
 
@@ -166,10 +161,7 @@ public function findAllByPid(?int $blogSetup = null)
         return $query->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllWithLimit(int $limit)
+    public function findAllWithLimit(int $limit): QueryResultInterface
     {
         $query = $this->getFindAllQuery();
         $query->setLimit($limit);
@@ -195,10 +187,7 @@ protected function getFindAllQuery(): QueryInterface
         return $query;
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllByAuthor(Author $author)
+    public function findAllByAuthor(Author $author): QueryResultInterface
     {
         $query = $this->createQuery();
         $constraints = $this->defaultConstraints;
@@ -211,10 +200,7 @@ public function findAllByAuthor(Author $author)
         return $query->matching($query->logicalAnd(...$constraints))->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllByCategory(Category $category)
+    public function findAllByCategory(Category $category): QueryResultInterface
     {
         $query = $this->createQuery();
         $constraints = $this->defaultConstraints;
@@ -227,10 +213,7 @@ public function findAllByCategory(Category $category)
         return $query->matching($query->logicalAnd(...$constraints))->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findAllByTag(Tag $tag)
+    public function findAllByTag(Tag $tag): QueryResultInterface
     {
         $query = $this->createQuery();
         $constraints = $this->defaultConstraints;
@@ -243,10 +226,7 @@ public function findAllByTag(Tag $tag)
         return $query->matching($query->logicalAnd(...$constraints))->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findByMonthAndYear(int $year, int $month = null)
+    public function findByMonthAndYear(int $year, int $month = null): QueryResultInterface
     {
         $query = $this->createQuery();
         $constraints = $this->defaultConstraints;
@@ -439,8 +419,6 @@ protected function getStoragePidsFromTypoScript(): array
 
     /**
      * @return null|ComparisonInterface
-     * @throws \TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException
-     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException
      */
     protected function getStoragePidConstraint(): ?ComparisonInterface
     {
@@ -452,9 +430,6 @@ protected function getStoragePidConstraint(): ?ComparisonInterface
         return null;
     }
 
-    /**
-     * @throws \TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException
-     */
     protected function getPidsForConstraints(): array
     {
         // only add non empty pids (pid 0 will be removed as well
@@ -472,9 +447,6 @@ protected function getPidsForConstraints(): array
         return $pids;
     }
 
-    /**
-     * @return TypoScriptFrontendController
-     */
     protected function getTypoScriptFrontendController(): ?TypoScriptFrontendController
     {
         return $GLOBALS['TSFE'] ?? null;

diff --git a/Classes/Domain/Repository/TagRepository.php b/Classes/Domain/Repository/TagRepository.php
@@ -14,6 +14,7 @@
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 use TYPO3\CMS\Extbase\Persistence\Repository;
 
 class TagRepository extends Repository
@@ -30,10 +31,7 @@ public function initializeObject(): void
         ];
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findByUids(array $uids)
+    public function findByUids(array $uids): QueryResultInterface
     {
         $query = $this->createQuery();
         $query->matching(
@@ -43,10 +41,7 @@ public function findByUids(array $uids)
         return $query->execute();
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function findTopByUsage(int $limit = 20)
+    public function findTopByUsage(int $limit = 20): array
     {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_blog_domain_model_tag');

diff --git a/Classes/Service/CommentService.php b/Classes/Service/CommentService.php
@@ -17,6 +17,7 @@
 use TYPO3\CMS\Core\Context\Context;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
 /**
  * Class CommentService.
@@ -99,10 +100,7 @@ protected function approvedCommentExistsForSameEmail(Comment $comment): bool
         )->execute()->count() > 0;
     }
 
-    /**
-     * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
-     */
-    public function getCommentsByPost(Post $post)
+    public function getCommentsByPost(Post $post): QueryResultInterface
     {
         return $this->commentRepository->findAllByPost($post);
     }