PageBrowsingViewHelper.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\IndexedSearch\ViewHelpers;
 
use ‪TYPO3\CMS\Core\Page\AssetCollector;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
final class ‪PageBrowsingViewHelper extends AbstractTagBasedViewHelper
{
    protected static string ‪$prefixId = 'tx_indexedsearch';
 
    protected ‪$tagName = 'ul';
 
    public function ‪__construct(private readonly ‪AssetCollector $assetCollector)
    {
        parent::__construct();
    }
 
    public function ‪initializeArguments(): void
    {
        $this->registerArgument('maximumNumberOfResultPages', 'int', '', true);
        $this->registerArgument('numberOfResults', 'int', '', true);
        $this->registerArgument('resultsPerPage', 'int', '', true);
        $this->registerArgument('currentPage', 'int', '', false, 0);
        $this->registerArgument('freeIndexUid', 'int', '');
        $this->registerUniversalTagAttributes();
    }
 
    public function ‪render(): string
    {
        $maximumNumberOfResultPages = $this->arguments['maximumNumberOfResultPages'];
        $numberOfResults = $this->arguments['numberOfResults'];
        $resultsPerPage = $this->arguments['resultsPerPage'];
        $currentPage = $this->arguments['currentPage'];
        $freeIndexUid = $this->arguments['freeIndexUid'];
 
        if ($resultsPerPage <= 0) {
            $resultsPerPage = 10;
        }
        $pageCount = (int)ceil($numberOfResults / $resultsPerPage);
        // only show the result browser if more than one page is needed
        if ($pageCount === 1) {
            return '';
        }
 
        // Check if $currentPage is in range
        $currentPage = ‪MathUtility::forceIntegerInRange($currentPage, 0, $pageCount - 1);
 
        $content = '';
        // prev page
        // show on all pages after the 1st one
        if ($currentPage > 0) {
            $label = ‪LocalizationUtility::translate('displayResults.previous', 'IndexedSearch') ?? '';
            $content .= '<li class="tx-indexedsearch-browselist-prev">' . $this->‪makecurrentPageSelector_link($label, $currentPage - 1, $freeIndexUid) . '</li>';
        }
        // Check if $maximumNumberOfResultPages is in range
        $maximumNumberOfResultPages = ‪MathUtility::forceIntegerInRange($maximumNumberOfResultPages, 1, $pageCount, 10);
        // Assume $currentPage is in the middle and calculate the index limits of the result page listing
        $minPage = $currentPage - (int)floor($maximumNumberOfResultPages / 2);
        $maxPage = $minPage + $maximumNumberOfResultPages - 1;
        // Check if the indexes are within the page limits
        if ($minPage < 0) {
            $maxPage -= $minPage;
            $minPage = 0;
        } elseif ($maxPage >= $pageCount) {
            $minPage -= $maxPage - $pageCount + 1;
            $maxPage = $pageCount - 1;
        }
        $pageLabel = ‪LocalizationUtility::translate('displayResults.page', 'IndexedSearch');
        for ($a = $minPage; $a <= $maxPage; $a++) {
            $isCurrentPage = $a === $currentPage;
            $label = trim($pageLabel . ' ' . ($a + 1));
            $label = $this->‪makecurrentPageSelector_link($label, $a, $freeIndexUid, $isCurrentPage);
            if ($isCurrentPage) {
                $content .= '<li class="tx-indexedsearch-browselist-currentPage"><strong>' . $label . '</strong></li>';
            } else {
                $content .= '<li>' . $label . '</li>';
            }
        }
        // next link
        if ($currentPage < $pageCount - 1) {
            $label = ‪LocalizationUtility::translate('displayResults.next', 'IndexedSearch') ?? '';
            $content .= '<li class="tx-indexedsearch-browselist-next">' . $this->‪makecurrentPageSelector_link($label, $currentPage + 1, $freeIndexUid) . '</li>';
        }
 
        if (!$this->tag->hasAttribute('class')) {
            $this->tag->addAttribute('class', 'tx-indexedsearch-browsebox');
        }
        $this->tag->setContent($content);
        return $this->tag->render();
    }
 
    protected function ‪makecurrentPageSelector_link($str, $p, $freeIndexUid, bool $isCurrentPage = false)
    {
        $this->‪providePageSelectorJavaScript();
        $attributes = [
            'href' => '#',
            'class' => 'tx-indexedsearch-page-selector',
            'data-prefix' => ‪self::$prefixId,
            'data-pointer' => $p,
            'data-freeIndexUid' => $freeIndexUid,
        ];
        if ($isCurrentPage) {
            $attributes['aria-current'] = 'page';
        }
        return sprintf(
            '<a %s>%s</a>',
            GeneralUtility::implodeAttributes($attributes, true),
            htmlspecialchars($str)
        );
    }
 
    private function ‪providePageSelectorJavaScript(): void
    {
        if ($this->assetCollector->hasInlineJavaScript(self::class)) {
            return;
        }
        $this->assetCollector->addInlineJavaScript(
            self::class,
            implode(' ', [
                "document.addEventListener('click', (evt) => {",
                "if (!evt.target.classList.contains('tx-indexedsearch-page-selector')) {",
                'return;',
                '}',
                'evt.preventDefault();',
                'var data = evt.target.dataset;',
                "document.getElementById(data.prefix + '_pointer').value = data.pointer;",
                "document.getElementById(data.prefix + '_freeIndexUid').value = data.freeIndexUid;",
                'document.getElementById(data.prefix).submit();',
                '});',
            ]),
            [],
            ['useNonce' => true],
        );
    }
}