[TASK] Streamline type annotations

TYPO3GmbH · May 22, 2023 · 8056c0f · 8056c0f
1 parent 0eeacbb
commit 8056c0f
Show file tree

Hide file tree

Showing 33 changed files with 74 additions and 430 deletions.
diff --git a/Classes/AvatarProvider/GravatarProvider.php b/Classes/AvatarProvider/GravatarProvider.php
@@ -27,20 +27,9 @@
 
 class GravatarProvider implements AvatarProviderInterface, SingletonInterface
 {
-    /**
-     * @var GravatarUriBuilderInterface
-     */
-    private $gravatarUriBuilder;
-
-    /**
-     * @var AvatarResourceResolverInterface
-     */
-    private $avatarResourceResolver;
-
-    /**
-     * @var bool
-     */
-    private $proxyGravatarImage;
+    private GravatarUriBuilderInterface $gravatarUriBuilder;
+    private AvatarResourceResolverInterface $avatarResourceResolver;
+    private bool $proxyGravatarImage;
 
     final public function __construct()
     {

diff --git a/Classes/Controller/CommentController.php b/Classes/Controller/CommentController.php
@@ -11,7 +11,6 @@
 namespace T3G\AgencyPack\Blog\Controller;
 
 use Psr\Http\Message\ResponseInterface;
-use T3G\AgencyPack\Blog\Domain\Model\Comment;
 use T3G\AgencyPack\Blog\Domain\Model\Post;
 use T3G\AgencyPack\Blog\Domain\Repository\PostRepository;
 use T3G\AgencyPack\Blog\Service\CacheService;
@@ -20,69 +19,36 @@
 
 class CommentController extends ActionController
 {
-    /**
-     * @var PostRepository
-     */
-    protected $postRepository;
-
-    /**
-     * @var CommentService
-     */
-    protected $commentService;
-
-    /**
-     * @var CacheService
-     */
-    protected $blogCacheService;
-
-    /**
-     * @param PostRepository $postRepository
-     */
-    public function injectPostRepository(PostRepository $postRepository): void
-    {
+    protected PostRepository $postRepository;
+    protected CommentService $commentService;
+    protected CacheService $cacheService;
+
+    public function __construct(
+        PostRepository $postRepository,
+        CommentService $commentService,
+        CacheService $cacheService
+    ) {
         $this->postRepository = $postRepository;
-    }
-
-    /**
-     * @param \T3G\AgencyPack\Blog\Service\CommentService $commentService
-     */
-    public function injectCommentService(CommentService $commentService): void
-    {
         $this->commentService = $commentService;
-    }
-
-    /**
-     * @param \T3G\AgencyPack\Blog\Service\CacheService $cacheService
-     */
-    public function injectBlogCacheService(CacheService $cacheService): void
-    {
-        $this->blogCacheService = $cacheService;
+        $this->cacheService = $cacheService;
     }
 
     /**
      * Show comment form.
-     *
-     * @throws \TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException
-     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException
      */
     public function formAction(): ResponseInterface
     {
         $this->view->assign('post', $this->postRepository->findCurrentPost());
         return $this->htmlResponse();
     }
 
-    /**
-     * @throws \TYPO3\CMS\Core\Context\Exception\AspectNotFoundException
-     * @throws \TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException
-     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException
-     */
     public function commentsAction(): ResponseInterface
     {
         $post = $this->postRepository->findCurrentPost();
         if ($post instanceof Post) {
             $comments = $this->commentService->getCommentsByPost($post);
             foreach ($comments as $comment) {
-                $this->blogCacheService->addTagToPage('tx_blog_comment_' . $comment->getUid());
+                $this->cacheService->addTagToPage('tx_blog_comment_' . $comment->getUid());
             }
             $this->view->assign('comments', $comments);
             $this->view->assign('post', $post);

diff --git a/Classes/Controller/WidgetController.php b/Classes/Controller/WidgetController.php
@@ -22,69 +22,24 @@
 
 class WidgetController extends ActionController
 {
-    /**
-     * @var CategoryRepository
-     */
-    protected $categoryRepository;
-
-    /**
-     * @var TagRepository
-     */
-    protected $tagRepository;
-
-    /**
-     * @var PostRepository
-     */
-    protected $postRepository;
-
-    /**
-     * @var CommentRepository
-     */
-    protected $commentRepository;
-
-    /**
-     * @var CacheService
-     */
-    protected $blogCacheService;
-
-    /**
-     * @param CategoryRepository $categoryRepository
-     */
-    public function injectCategoryRepository(CategoryRepository $categoryRepository): void
-    {
+    protected CategoryRepository $categoryRepository;
+    protected TagRepository $tagRepository;
+    protected PostRepository $postRepository;
+    protected CommentRepository $commentRepository;
+    protected CacheService $cacheService;
+
+    public function __construct(
+        CategoryRepository $categoryRepository,
+        TagRepository $tagRepository,
+        PostRepository $postRepository,
+        CommentRepository $commentRepository,
+        CacheService $cacheService
+    ) {
         $this->categoryRepository = $categoryRepository;
-    }
-
-    /**
-     * @param TagRepository $tagRepository
-     */
-    public function injectTagRepository(TagRepository $tagRepository): void
-    {
         $this->tagRepository = $tagRepository;
-    }
-
-    /**
-     * @param PostRepository $postRepository
-     */
-    public function injectPostRepository(PostRepository $postRepository): void
-    {
         $this->postRepository = $postRepository;
-    }
-
-    /**
-     * @param CommentRepository $commentRepository
-     */
-    public function injectCommentRepository(CommentRepository $commentRepository): void
-    {
         $this->commentRepository = $commentRepository;
-    }
-
-    /**
-     * @param \T3G\AgencyPack\Blog\Service\CacheService $cacheService
-     */
-    public function injectBlogCacheService(CacheService $cacheService): void
-    {
-        $this->blogCacheService = $cacheService;
+        $this->cacheService = $cacheService;
     }
 
     public function categoriesAction(): ResponseInterface
@@ -98,7 +53,7 @@ public function categoriesAction(): ResponseInterface
         $this->view->assign('categories', $categories);
         $this->view->assign('currentCategory', $currentCategory);
         foreach ($categories as $category) {
-            $this->blogCacheService->addTagToPage('tx_blog_category_' . $category->getUid());
+            $this->cacheService->addTagToPage('tx_blog_category_' . $category->getUid());
         }
         return $this->htmlResponse();
     }
@@ -136,18 +91,13 @@ public function tagsAction(): ResponseInterface
         }
         unset($tagReference);
         foreach ($tags as $tag) {
-            $this->blogCacheService->addTagToPage('tx_blog_tag_' . (int)$tag['uid']);
+            $this->cacheService->addTagToPage('tx_blog_tag_' . (int)$tag['uid']);
         }
         $this->view->assign('tags', $tags);
         $this->view->assign('currentTag', $currentTag);
         return $this->htmlResponse();
     }
 
-    /**
-     * @throws \TYPO3\CMS\Core\Context\Exception\AspectNotFoundException
-     * @throws \TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException
-     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException
-     */
     public function recentPostsAction(): ResponseInterface
     {
         $limit = (int)($this->settings['widgets']['recentposts']['limit'] ?? 0);
@@ -157,31 +107,24 @@ public function recentPostsAction(): ResponseInterface
             : $this->postRepository->findAll();
 
         foreach ($posts as $post) {
-            $this->blogCacheService->addTagsForPost($post);
+            $this->cacheService->addTagsForPost($post);
         }
         $this->view->assign('posts', $posts);
         return $this->htmlResponse();
     }
 
-    /**
-     * @throws \TYPO3\CMS\Core\Context\Exception\AspectNotFoundException
-     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException
-     */
     public function commentsAction(): ResponseInterface
     {
         $limit = (int)($this->settings['widgets']['comments']['limit'] ?? 5);
         $blogSetup = isset($this->settings['widgets']['comments']['blogSetup']) ? (int) $this->settings['widgets']['comments']['blogSetup'] : null;
         $comments = $this->commentRepository->findActiveComments($limit, $blogSetup);
         $this->view->assign('comments', $comments);
         foreach ($comments as $comment) {
-            $this->blogCacheService->addTagToPage('tx_blog_comment_' . $comment->getUid());
+            $this->cacheService->addTagToPage('tx_blog_comment_' . $comment->getUid());
         }
         return $this->htmlResponse();
     }
 
-    /**
-     * @throws \TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException
-     */
     public function archiveAction(): ResponseInterface
     {
         $posts = $this->postRepository->findMonthsAndYearsWithPosts();

diff --git a/Classes/DataTransferObject/AvatarResource.php b/Classes/DataTransferObject/AvatarResource.php
@@ -15,8 +15,6 @@
 interface AvatarResource
 {
     public function getUri(): UriInterface;
-
     public function getContentType(): string;
-
     public function getContent(): string;
 }
diff --git a/Classes/DataTransferObject/Gravatar.php b/Classes/DataTransferObject/Gravatar.php
@@ -14,20 +14,9 @@
 
 class Gravatar implements AvatarResource
 {
-    /**
-     * @var UriInterface
-     */
-    private $uri;
-
-    /**
-     * @var string
-     */
-    private $contentType;
-
-    /**
-     * @var string
-     */
-    private $content;
+    private UriInterface $uri;
+    private string $contentType;
+    private string $content;
 
     public function __construct(UriInterface $uri, string $contentType, string $content)
     {

diff --git a/Classes/DataTransferObject/PostRepositoryDemand.php b/Classes/DataTransferObject/PostRepositoryDemand.php
@@ -19,37 +19,26 @@ class PostRepositoryDemand
     /**
      * @var int[]
      */
-    protected $posts = [];
+    protected array $posts = [];
 
     /**
      * @var Category[]
      */
-    protected $categories = [];
-
-    /**
-     * @var string
-     */
-    protected $categoriesConjunction = Constants::REPOSITORY_CONJUNCTION_AND;
+    protected array $categories = [];
+    protected string $categoriesConjunction = Constants::REPOSITORY_CONJUNCTION_AND;
 
     /**
      * @var Tag[]
      */
-    protected $tags = [];
-
-    /**
-     * @var string
-     */
-    protected $tagsConjunction = Constants::REPOSITORY_CONJUNCTION_AND;
+    protected array $tags = [];
+    protected string $tagsConjunction = Constants::REPOSITORY_CONJUNCTION_AND;
 
     /**
      * @var string[]
      */
-    protected $ordering = [];
+    protected array $ordering = [];
 
-    /**
-     * @var int
-     */
-    protected $limit = 0;
+    protected int $limit = 0;
 
     /**
      * @return int[]
@@ -100,9 +89,6 @@ public function removeCategory(Category $category): self
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getCategoriesConjunction(): string
     {
         return $this->categoriesConjunction;
@@ -140,9 +126,6 @@ public function removeTag(Tag $tag): self
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getTagsConjunction(): string
     {
         return $this->tagsConjunction;

diff --git a/Classes/Domain/Factory/CommentFormFactory.php b/Classes/Domain/Factory/CommentFormFactory.php
@@ -34,10 +34,6 @@ class CommentFormFactory extends AbstractFormFactory
      * Build a FormDefinition.
      * This example build a FormDefinition manually,
      * so $configuration and $prototypeName are unused.
-     *
-     * @param array $configuration
-     * @param string $prototypeName
-     * @return FormDefinition
      */
     public function build(array $configuration, string $prototypeName = null): FormDefinition
     {

diff --git a/Classes/Domain/Repository/AuthorRepository.php b/Classes/Domain/Repository/AuthorRepository.php
@@ -18,11 +18,6 @@
  */
 class AuthorRepository extends Repository
 {
-    /**
-     * Initializes the repository.
-     *
-     * @throws \InvalidArgumentException
-     */
     public function initializeObject(): void
     {
         $this->defaultOrderings = [