Lines 100.00% 30 / 30
Functions and Methods 100.00% 5 / 5
Classes and Traits 100.00% 1 / 1
Name Lines Functions and Methods CRAP Classes and Traits
ListTemplater 100.00% 30 / 30 100.00% 5 / 5 6 100.00% 1 / 1
 __construct 100.00% 1 / 1 100.00% 1 / 1 1
 prepareTemplateData 100.00% 9 / 9 100.00% 1 / 1 1
 createOrderingLinks 100.00% 4 / 4 100.00% 1 / 1 2
 createPagination 100.00% 11 / 11 100.00% 1 / 1 1
 createFilter 100.00% 5 / 5 100.00% 1 / 1 1
1<?php
2
3declare(strict_types=1);
4
5namespace Districts\Editor\UI\View;
6
7use Districts\Editor\Domain\PaginatedResult;
8use Psr\Http\Message\ServerRequestInterface;
9use Psr\Http\Message\UriFactoryInterface;
10
11/**
12 * @template T
13 */
14final readonly class ListTemplater
15{
16    public function __construct(
17        private PageReferenceFactory $pageReferenceFactory,
18        private OrderingLinkGenerator $orderingLinkGenerator,
19        private UriFactoryInterface $uriFactory,
20    ) {
21    }
22
23    /**
24     * @param PaginatedResult<T> $paginatedResult
25     * @param string[] $orderingColumns
26     *
27     * @return array<string, mixed>
28     */
29    public function prepareTemplateData(
30        PaginatedResult $paginatedResult,
31        ServerRequestInterface $request,
32        array $orderingColumns,
33        string $title,
34        mixed $successMessage,
35        mixed $errorMessage,
36    ): array {
37        return [
38            "title" => $title,
39            "successMessage" => $successMessage,
40            "errorMessage" => $errorMessage,
41            "entries" => $paginatedResult->currentPageEntries,
42            "orderingLinks" => $this->createOrderingLinks($request, $orderingColumns),
43            "pagination" => $this->createPagination($request, $paginatedResult),
44            "filter" => $this->createFilter($request),
45        ];
46    }
47
48    /**
49     * @param string[] $columns
50     *
51     * @return array<string, OrderingLink>
52     */
53    private function createOrderingLinks(ServerRequestInterface $request, array $columns): array
54    {
55        $links = [];
56        foreach ($columns as $column) {
57            $links[$column] = $this->orderingLinkGenerator->createOrderingLink($request, $column);
58        }
59        return $links;
60    }
61
62    /**
63     * @param PaginatedResult<T> $paginatedResult
64     *
65     * @return PageReference[]
66     */
67    private function createPagination(ServerRequestInterface $request, PaginatedResult $paginatedResult): array
68    {
69        $requestUrl = $request->getUri();
70        $relativeUrl = ($this->uriFactory->createUri())
71            ->withPath($requestUrl->getPath())
72            ->withQuery($requestUrl->getQuery()); // query parameters must be preserved for filtering
73        return iterator_to_array(
74            $this->pageReferenceFactory->createPageReferencesForUrl(
75                $relativeUrl,
76                $paginatedResult->pageCount,
77                $paginatedResult->pagination->pageNumber
78            )
79        );
80    }
81
82    private function createFilter(ServerRequestInterface $request): Filter
83    {
84        $queryParams = $request->getQueryParams();
85        return new Filter(
86            $queryParams["filterColumn"] ?? null,
87            $queryParams["filterValue"] ?? null,
88        );
89    }
90}