[TASK] Update TeaController and Repository (#5411)

* [TASK] Update TeaController and Repository

Resolves: #3864
Releases: main, 13.4

* [TASK] Update TeaController and Repository

Resolves: #3864
Releases: main, 13.4

Author: linawolf

Documentation/CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/InjectRepository.rst.txt

@@ -36,7 +36,7 @@ objects from the repository and hands them over to the view:
 
 The controller has to access the :php:`TeaRepository` to find all available tea
 objects. We use :ref:`Dependency Injection <DependencyInjection>` to make the
-repository available to the controller: The method :php:`injectTeaRepository()`
+repository available to the controller: The constructor
 will be called automatically with an initialized :php:`TeaRepository` when
 the :php:`TeaController` is created.
 

Documentation/CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/StoragePageAgnosticTrait.rst.txt

@@ -12,72 +12,45 @@ A basic repository can be quite a short class. The shortest possible
 repository is an empty class inheriting from
 :php:`TYPO3\CMS\Extbase\Persistence\Repository`:
 
-..  code-block:: php
-    :caption: EXT:tea/Classes/Domain/Repository/Product/TeaRepository.php
-
-    <?php
-
-    declare(strict_types=1);
-
-    namespace TTN\Tea\Domain\Repository\Product;
-
-    use TYPO3\CMS\Extbase\Persistence\Repository;
-
-    class TeaRepository extends Repository
-    {
-    }
+..  literalinclude:: _Repository/_BasicRepository.php
+    :caption: EXT:tea/Classes/Domain/Repository/Product/TeaRepository.php (simplified)
 
 The model the repository should deliver is derived from the namespace and
 name of the repository. A repository with the fully qualified name
 :php:`TTN\Tea\Domain\Repository\Product\TeaRepository` therefore delivers
 models with the fully qualified name :php:`TTN\Tea\Domain\Model\Product\Tea`
 without further configuration.
 
-In the EXT:tea extension some additional settings are required. These can be
-done directly in the Repository or in a
-`trait <https://www.php.net/manual/en/language.oop5.traits.php>`__. It is
-important to know, that a trait overrides parameters and method from the
-parent class but can be overridden from the current class.
+A special class comment (not mandatory), `@extends Repository<Tea>` tells your IDE and
+static analytic tools like PHPStan that the find-by methods of this repository
+return objects of type :php-short:`TTN\Tea\Domain\Model\Product\Tea`.
 
-The :php:`TeaRepository` configures the :php:`$defaultOrderings` directly in
-the repository class and imports additional settings from the trait.
+The repository in the tea extension looks like this:
 
-..  include:: /CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/TeaRepository.rst.txt
+..  literalinclude:: _Repository/_BasicRepository.php
+    :caption: EXT:tea/Classes/Domain/Repository/Product/TeaRepository.php
 
 We override the protected parameter :php:`$defaultOrderings` here. This parameter
 is also defined in the parent class
 :php:`TYPO3\CMS\Extbase\Persistence\Repository` and used here when querying
 the database.
 
-The trait itself is also defined in the extension:
-
-..  include:: /CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/StoragePageAgnosticTrait.rst.txt
-
-Here we inject the :php:`$querySettings` and allow to fetch tea objects from
-all pages. We then set these as default query settings.
+Then we also add a custom find-by method. See also chapter
+:ref:`"Repository" in the Extbase reference <extbase-repository>`.
 
-The advantage of using a trait here instead of defining the parameters and
-methods directly in the repository is, that the code can be reused without
-requiring inheritance. Repositories of non-related models should not inherit
-from each other.
+..  _extbase_tutorial_tea_repository-usage:
 
 Using the repository
 ====================
 
-The :php:`\TTN\Tea\Domain\Repository\Product\TeaRepository` can now be used in a
-controller or another class.
+The :php-short:`\TTN\Tea\Domain\Repository\Product\TeaRepository` can now be
+used in a controller or another class, for example a service.
 
-Require it via :ref:`Dependency Injection <Dependency-Injection>`:
+Require it via :ref:`Dependency Injection <Dependency-Injection>` in the
+constructor:
 
-..  include:: /CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/InjectRepository.rst.txt
-
-Then it can be used:
-
-..  include:: /CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/UseRepository.rst.txt
+..  literalinclude:: _Repository/_InjectRepository.php
+    :caption: EXT:tea/Classes/Controller/TeaController.php
 
 The method :php:`$this->teaRepository->findAll()` that is called here is
-defined in the parent class :php:`Repository`.
-
-You can also add additional methods here to query the database. See chapter
-:ref:`"Repository" in the Extbase reference <extbase-repository>`. As this
-example is very basic we do not need custom find methods.
+defined in the parent class :php:`\TYPO3\CMS\Extbase\Persistence\Repository`.

Documentation/CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/TeaRepository.rst.txt

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TTN\Tea\Domain\Repository\Product;
+
+use TYPO3\CMS\Extbase\Persistence\Repository;
+
+/**
+ * @extends Repository<Tea>
+ */
+class TeaRepository extends Repository {}

Documentation/CodeSnippets/Tutorials/Tea/Classes/Domain/Repository/UseRepository.rst.txt

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TTN\Tea\Controller;
+
+use Psr\Http\Message\ResponseInterface;
+use TTN\Tea\Domain\Repository\Product\TeaRepository;
+use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
+
+final class TeaController extends ActionController
+{
+    public function __construct(private TeaRepository $teaRepository) {}
+
+    public function indexAction(): ResponseInterface
+    {
+        $this->view->assign('teas', $this->teaRepository->findAll());
+        return $this->htmlResponse();
+    }
+}

Documentation/ExtensionArchitecture/Tutorials/Tea/Controller.rst

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TTN\Tea\Domain\Repository;
+
+use TTN\Tea\Domain\Model\Tea;
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
+use TYPO3\CMS\Extbase\Persistence\Repository;
+
+/**
+ * @extends Repository<Tea>
+ */
+class TeaRepository extends Repository
+{
+    protected $defaultOrderings = ['title' => QueryInterface::ORDER_ASCENDING];
+
+    public function findByOwnerUid(int $ownerUid): QueryResultInterface
+    {
+        $query = $this->createQuery();
+        $query->setQuerySettings($query->getQuerySettings()->setRespectStoragePage(false));
+        $query->matching($query->equals('ownerUid', $ownerUid));
+
+        return $query->execute();
+    }
+}