feat: search bar on TYPO3 13, loaded into the static pages, searching by GET

The search bar in the page header is back (SearchbarController, lib.searchBar
and lib.searchBarCollapsed), in the Subpage, SubpageSidebarRight and Detail
layouts as on TYPO3 10; product pages get the collapsed bar and its toggle
button in the main navigation again.

- The bar takes no arguments, so it is the same on every page of a site and
  cacheable. Page types 1706/1707 (/searchbar, /searchbar-collapsed on the
  ep-reisen root, also under /en/) render it alone for the static pages,
  which replace their exported bar with it via htmx. The suffixes have no
  leading slash: on the root page the route path has none, so "/searchbar"
  would never match (as /form and /snowreport do not there either).
- The form sends dateFrom, dateTo, pax, destinationType, destinationUid and
  priceRange by GET to the search page instead of POSTing to processSearch:
  no signed fields and no redirect, and URLs of about 100 characters instead
  of about 870. SearchController reads them (SEARCHBAR_PARAMETERS, excluded
  from the cHash; the results are not cached) and drops anything but a real
  Y-m-d date, which made DateUtility::formatDateRange() throw.
  processSearch is removed.
- The date range label is empty without arguments, so the template no longer
  needs ep:dateRange.

Compared with TYPO3 10: the bar's markup matches apart from the form (open,
collapsed, /en/); seven searches by GET load the same filter settings and
hit counts as the TYPO3 10 POST.

The static pages get the island from the exporter in EP/website, see
.ddev/plans/static-export-searchbar-island.patch (local only).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
frommeandClaude Opus 5.5 committed 2026-10-22 15:43:24 +02:00
1 parent b5637ba86e
commit 48e049671e
11 files changed
+444 -49

No files matched your search

@@ -40,6 +40,12 @@ class SearchController extends ActionController
use RequestArgumentTypeConversionTrait;
/**
* The fields of the search bar (Templates/Searchbar/Index.html), sent by GET to the search
* page and excluded from the cHash: the visitor chooses the values
*/
public const SEARCHBAR_PARAMETERS = ['dateFrom', 'dateTo', 'pax', 'destinationType', 'destinationUid', 'priceRange'];
/**
* @var FilterService
*/
@@ -59,32 +65,6 @@ class SearchController extends ActionController
$this->searchResultService = $searchResultService;
}
public function initializeProcessSearchAction()
{
$this->processSearchParamsArgument();
}
/**
* @param array $searchParams
*/
public function processSearchAction(array $searchParams): ResponseInterface
{
$filterSettings = $this->filterService->getFilterSettingsFromSearchParams($searchParams);
$redirectUri = $this->uriBuilder
->reset()
->setCreateAbsoluteUri(true)
->uriFor(
'searchresult',
['filterSettings' => $filterSettings],
null,
null,
'searchresult'
);
return $this->redirectToUri($redirectUri);
}
public function initializeSearchresultAction()
{
// Process encoded filtersettings from static search result.
@@ -98,6 +78,24 @@ class SearchController extends ActionController
$this->request = $this->request->withArgument('filterSettings', $filterSettings);
}
}
// The fields of the search bar, which sends them here by GET
$searchbarParameters = array_filter(
array_intersect_key($this->request->getQueryParams(), array_flip(self::SEARCHBAR_PARAMETERS)),
'is_string'
);
// Anything but a real Y-m-d date is dropped: the URL is easy to edit, and
// DateUtility::formatDateRange() throws on what DateTime cannot read
foreach (['dateFrom', 'dateTo'] as $name) {
$date = \DateTime::createFromFormat('!Y-m-d', $searchbarParameters[$name] ?? '');
if (!$date || $date->format('Y-m-d') !== $searchbarParameters[$name]) {
unset($searchbarParameters[$name]);
}
}
if ($searchbarParameters !== [] && !$this->request->hasArgument('filterSettings')) {
$searchParams = $this->searchResultService->getNormalizedSearchParams($searchbarParameters);
$filterSettings = $this->filterService->getFilterSettingsFromSearchParams($searchParams);
$this->request = $this->request->withArgument('filterSettings', $filterSettings);
}
$forcedConceptUids = GeneralUtility::intExplode(',', $this->settings['forcedConceptUids'] ?? '', true);
$this->processFilterSettingsArgument($forcedConceptUids);
}
@@ -0,0 +1,66 @@
<?php
namespace EP\EpProducts\Controller;
/***************************************************************
*
* Copyright notice
*
* (c) 2016 Björn Fromme <[email protected]>, dreipunktnull
*
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project is
* free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
use EP\EpProducts\Service\FilterService;
use EP\EpProducts\Service\SearchResultService;
use Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
/**
* The search bar in the page header. It takes no arguments: the options come from the products
* the site can show, so the output is the same on every page of a site (cacheable), and the
* static pages of the hybrid setup load it from <site root>/searchbar (Page/Searchbar.typoscript).
* The form sends its fields by GET to the search page (SearchController::SEARCHBAR_PARAMETERS).
*/
class SearchbarController extends ActionController
{
public function __construct(
private readonly FilterService $filterService,
private readonly SearchResultService $searchResultService,
) {
}
public function indexAction(): ResponseInterface
{
$searchParams = $this->searchResultService->getNormalizedSearchParams();
$forcedConceptUids = GeneralUtility::intExplode(',', $this->settings['forcedConceptUids'] ?? '', true);
$filterSettings = $this->filterService->getFilterSettingsFromSearchParams($searchParams, $forcedConceptUids);
$excludedConceptUids = GeneralUtility::intExplode(',', $this->settings['excludedConceptUids'] ?? '', true);
$searchResult = $this->searchResultService->getResult($filterSettings, $excludedConceptUids);
$this->view->assignMultiple([
'filterOptions' => $this->filterService->collectFilterOptionsFromSearchResult($searchResult),
'searchParams' => $searchParams,
'collapsed' => (bool)($this->settings['collapsed'] ?? false),
]);
return $this->htmlResponse();
}
}
@@ -3,30 +3,11 @@
namespace EP\EpProducts\Traits;
use EP\EpProducts\Service\FilterService;
use EP\EpProducts\Service\SearchResultService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
trait RequestArgumentTypeConversionTrait
{
public function processSearchParamsArgument(): void
{
/** @var SearchResultService $searchResultService */
$searchResultService = GeneralUtility::makeInstance(SearchResultService::class);
if (!$this->request->hasArgument('searchParams')) {
$searchParams = $searchResultService->getNormalizedSearchParams();
} else {
$requestArgument = $this->request->getArgument('searchParams');
$searchParamsFromRequest = is_array($requestArgument) ?
$requestArgument : json_decode($requestArgument, true, 512, JSON_THROW_ON_ERROR);
$searchParams = $searchResultService->getNormalizedSearchParams($searchParamsFromRequest);
}
$this->request = $this->request->withArgument('searchParams', $searchParams);
}
public function processFilterSettingsArgument(array $forcedConceptUids = []): void
{
+18 -2
View File
@@ -2,6 +2,7 @@
use TYPO3\CMS\Extbase\Utility\ExtensionUtility;
use EP\EpProducts\Controller\ProductController;
use EP\EpProducts\Controller\SearchController;
use EP\EpProducts\Controller\SearchbarController;
use EP\EpProducts\Controller\SnowreportController;
use EP\EpProducts\Controller\TravelinfoController;
use EP\EpProducts\Controller\WatchlistController;
@@ -59,10 +60,19 @@ $boot = function () {
'EpProducts',
'searchresult',
[
SearchController::class => 'searchresult,processSearch',
SearchController::class => 'searchresult',
],
[
SearchController::class => 'searchresult,processSearch',
SearchController::class => 'searchresult',
]
);
// The search bar in the page header (lib.searchBar), not a content element
ExtensionUtility::configurePlugin(
'EpProducts',
'searchbar',
[
SearchbarController::class => 'index',
]
);
@@ -123,6 +133,12 @@ $boot = function () {
// The client-side callers that vary month/year (calendar_controller.js) send them in a
// POST body, which the cHash never inspects, so nothing depends on the exclusion.
$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParameters'][] = 'f';
// The search bar sends its fields by GET to the search page, whose results are not cached
// (SearchController::SEARCHBAR_PARAMETERS)
array_push(
$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParameters'],
...SearchController::SEARCHBAR_PARAMETERS
);
$GLOBALS['TYPO3_CONF_VARS']['SYS']['routing']['aspects']['PassthroughMapper'] =
PassthroughMapper::class;