[TASK] Extract code snippets into dedicated files (TYPO3-Documentatio…

…n#4803) Additionally, embed code examples into an Extbase controller class. Releases: main, 12.4
conpassione · Oct 3, 2024 · 69abe01 · 69abe01
1 parent f042fa6
commit 69abe01
Show file tree

Hide file tree

Showing 4 changed files with 124 additions and 75 deletions.
diff --git a/Documentation/ApiOverview/Pagination/Index.rst b/Documentation/ApiOverview/Pagination/Index.rst
@@ -24,53 +24,17 @@ Two concrete paginators are available:
 *  For type :php:`\TYPO3\CMS\Extbase\Persistence\QueryResultInterface`:
    :php:`\TYPO3\CMS\Extbase\Pagination\QueryResultPaginator`
 
-Code example for the :php:`ArrayPaginator`:
-
-.. code-block:: php
-
-   // use TYPO3\CMS\Core\Pagination\ArrayPaginator;
-
-   $itemsToBePaginated = ['apple', 'banana', 'strawberry', 'raspberry', 'pineapple'];
-   $itemsPerPage = 2;
-   $currentPageNumber = 3;
-
-   $paginator = new ArrayPaginator($itemsToBePaginated, $currentPageNumber, $itemsPerPage);
-   $paginator->getNumberOfPages(); // returns 3
-   $paginator->getCurrentPageNumber(); // returns 3, basically just returns the input value
-   $paginator->getKeyOfFirstPaginatedItem(); // returns 4
-   $paginator->getKeyOfLastPaginatedItem(); // returns 4
-
-   // use TYPO3\CMS\Core\Pagination\SimplePagination;
-
-   $pagination = new SimplePagination($paginator);
-   $pagination->getAllPageNumbers(); // returns [1, 2, 3]
-   $pagination->getPreviousPageNumber(); // returns 2
-   $pagination->getNextPageNumber(); // returns null
-   // …
-
-   $this->view->assignMultiple(
-       [
-           'pagination' => $pagination,
-           'paginator' => $paginator,
-       ]
-   );
-
-.. code-block:: html
-
-   <ul class="pagination">
-      <f:for each="{pagination.allPageNumbers}" as="page">
-         <li class="page-item">
-            <f:link.action arguments="{currentPageNumber:page}"
-                           class="page-link {f:if(condition:'{currentPageNumber}=={page}',then:'active')}">
-               {page}
-            </f:link.action>
-         </li>
-      </f:for>
-   </ul>
-
-   <f:for each="{paginator.paginatedItems}" as="item">
-       {item}
-   </f:for>
+Code example for the :php:`ArrayPaginator` in an
+:ref:`Extbase controller <extbase-action-controller>`:
+
+..  literalinclude:: _ArrayPaginatorExampleController.php
+    :caption: EXT:my_extension/Controller/ExampleController.php
+
+And the corresponding Fluid template:
+
+..  literalinclude:: _ArrayPaginatorExamplePagination.html
+    :caption: EXT:my_extension/Resources/Private/Templates/ExamplePagination.html
+
 
 Sliding window pagination
 =========================
@@ -93,31 +57,5 @@ Replace the usage of :php:`SimplePagination` with
 :php:`\TYPO3\CMS\Core\Pagination\SlidingWindowPagination` and you are done. Set
 the 2nd argument to the maximum number of links which should be rendered.
 
-.. code-block:: php
-
-   // use TYPO3\CMS\Extbase\Pagination\QueryResultPaginator;
-   // use TYPO3\CMS\Core\Pagination\SlidingWindowPagination;
-
-   $currentPage = $this->request->hasArgument('currentPageNumber')
-       ? (int)$this->request->getArgument('currentPageNumber')
-       : 1;
-   $itemsPerPage = 10;
-   $maximumLinks = 15;
-
-   $paginator = new QueryResultPaginator(
-       $allItems,
-       $currentPage,
-       $itemsPerPage
-   );
-   $pagination = new SlidingWindowPagination(
-       $paginator,
-       $maximumLinks
-   );
-
-   $this->view->assign(
-       'pagination',
-       [
-           'pagination' => $pagination,
-           'paginator' => $paginator,
-       ]
-   );
+..  literalinclude:: _SlidingWindowExampleController.php
+    :caption: EXT:my_extension/Controller/ExampleController.php
diff --git a/Documentation/ApiOverview/Pagination/_ArrayPaginatorExampleController.php b/Documentation/ApiOverview/Pagination/_ArrayPaginatorExampleController.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyVendor\MyExtension\Controller;
+
+use Psr\Http\Message\ResponseInterface;
+use TYPO3\CMS\Core\Pagination\ArrayPaginator;
+use TYPO3\CMS\Core\Pagination\SimplePagination;
+use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
+
+final class ExampleController extends ActionController
+{
+    public function myAction(): ResponseInterface
+    {
+        // For better demonstration we create fixed items, in real
+        // world usage a list of models is used instead.
+        $itemsToBePaginated = ['apple', 'banana', 'strawberry', 'raspberry', 'pineapple'];
+        $itemsPerPage = 2;
+        $currentPageNumber = 3;
+
+        $paginator = new ArrayPaginator($itemsToBePaginated, $currentPageNumber, $itemsPerPage);
+        $paginator->getNumberOfPages(); // returns 3
+        $paginator->getCurrentPageNumber(); // returns 3, basically just returns the input value
+        $paginator->getKeyOfFirstPaginatedItem(); // returns 4
+        $paginator->getKeyOfLastPaginatedItem(); // returns 4
+
+        $pagination = new SimplePagination($paginator);
+        $pagination->getAllPageNumbers(); // returns [1, 2, 3]
+        $pagination->getPreviousPageNumber(); // returns 2
+        $pagination->getNextPageNumber(); // returns null
+
+        // ... more logic ...
+
+        $this->view->assignMultiple(
+            [
+                'pagination' => $pagination,
+                'paginator' => $paginator,
+            ],
+        );
+
+        return $this->htmlResponse();
+    }
+}
diff --git a/Documentation/ApiOverview/Pagination/_ArrayPaginatorExamplePagination.html b/Documentation/ApiOverview/Pagination/_ArrayPaginatorExamplePagination.html
@@ -0,0 +1,16 @@
+<ul class="pagination">
+    <f:for each="{pagination.allPageNumbers}" as="page">
+        <li class="page-item">
+            <f:link.action
+                arguments="{currentPageNumber:page}"
+                class="page-link {f:if(condition:'{currentPageNumber}=={page}',then:'active')}"
+            >
+                {page}
+            </f:link.action>
+        </li>
+    </f:for>
+</ul>
+
+<f:for each="{paginator.paginatedItems}" as="item">
+    {item}
+</f:for>
diff --git a/Documentation/ApiOverview/Pagination/_SlidingWindowExampleController.php b/Documentation/ApiOverview/Pagination/_SlidingWindowExampleController.php
@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyVendor\MyExtension\Controller;
+
+use MyVendor\MyExtension\Domain\Repository\ExampleRepository;
+use Psr\Http\Message\ResponseInterface;
+use TYPO3\CMS\Core\Pagination\SlidingWindowPagination;
+use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
+use TYPO3\CMS\Extbase\Pagination\QueryResultPaginator;
+
+final class ExampleController extends ActionController
+{
+    public function __construct(
+        private readonly ExampleRepository $exampleRepository,
+    ) {}
+
+    public function myAction(): ResponseInterface
+    {
+        $allItems = $this->exampleRepository->findAll();
+
+        $currentPage = $this->request->hasArgument('currentPageNumber')
+            ? (int)$this->request->getArgument('currentPageNumber')
+            : 1;
+        $itemsPerPage = 10;
+        $maximumLinks = 15;
+
+        $paginator = new QueryResultPaginator(
+            $allItems,
+            $currentPage,
+            $itemsPerPage,
+        );
+        $pagination = new SlidingWindowPagination(
+            $paginator,
+            $maximumLinks,
+        );
+
+        // ... more logic ...
+
+        $this->view->assign(
+            'pagination',
+            [
+                'pagination' => $pagination,
+                'paginator' => $paginator,
+            ],
+        );
+
+        return $this->htmlResponse();
+    }
+}