Optimize code

Author: ipf

.github/workflows/ci.yml

@@ -1,48 +1,52 @@
 name: CI
 
-on: [ push, pull_request ]
+on:
+  [push, pull_request]
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
-    continue-on-error: ${{ matrix.env.experimental == true }}
     strategy:
       fail-fast: false
       matrix:
-        env:
-          - { php: 8.2 }
-          - { php: 8.3 }
-
-    env: ${{ matrix.env }}
+        php: [8.2, 8.3]
 
     steps:
-      - name: Checkout
+      - name: Checkout code
         uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.env.php }}
+          php-version: ${{ matrix.php }}
           tools: composer:2
           extensions: pdo, sqlite3
 
-      - name: Validate composer.json and composer.lock
-        run: composer validate
+      - name: Validate composer files
+        run: composer validate --strict
 
-      - name: Cache dependencies
+      - name: Cache Composer dependencies
         uses: actions/cache@v4
         with:
           path: ~/.composer/cache
-          key: dependencies-composer-${{ matrix.env.php }}-${{ hashFiles('composer.json') }}
+          key: ${{ runner.os }}-composer-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
 
       - name: Install dependencies
-        run: composer install
+        run: composer install --prefer-dist --no-interaction
 
-      - name: Check coding style
+      - name: Check coding style (optional)
         run: composer lint
+        continue-on-error: true # In case you want to not fail build if lint fails
 
       - name: Run Unit Tests
         run: |
-          echo "Running unit tests with $(which php)";
-          .Build/bin/phpunit --colors Tests/Unit/;
+          echo "Running unit tests with $(which php)"
+          if [ -f .Build/bin/phpunit ]; then
+            .Build/bin/phpunit --colors=always Tests/Unit/
+          elif [ -f vendor/bin/phpunit ]; then
+            vendor/bin/phpunit --colors=always Tests/Unit/
+          else
+            echo "phpunit binary not found!"
+            exit 1
+          fi

.nvmrc

@@ -1 +1 @@
-16
+22

Classes/Controller/SearchController.php

@@ -34,6 +34,7 @@
 use Subugoe\Find\Utility\ArrayUtility;
 use Subugoe\Find\Utility\FrontendUtility;
 use TYPO3\CMS\Core\Page\AssetCollector;
+use TYPO3\CMS\Core\PageTitle\PageTitleProviderInterface;
 use TYPO3\CMS\Core\Utility\ArrayUtility as CoreArrayUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Http\ForwardResponse;
@@ -44,9 +45,9 @@ class SearchController extends ActionController
 {
     protected array $requestArguments = [];
 
-    protected ?object $searchProvider = null;
+    protected ?ServiceProviderInterface $searchProvider = null;
 
-    public function __construct(private readonly AssetCollector $assetCollector, private readonly LoggerInterface $logger) {}
+    public function __construct(private readonly AssetCollector $assetCollector, private readonly LoggerInterface $logger, private readonly PageTitleProviderInterface $pageTitleProvider) {}
 
     /**
      * @throws NoSuchArgumentException|\JsonException
@@ -93,8 +94,7 @@ public function indexAction(): ResponseInterface
             $this->searchProvider->getRequestArguments()
         );
 
-        GeneralUtility::makeInstance(AssetCollector::class)
-            ->addInlineJavaScript('underlyingQueryVar', $underlyingQueryScriptTagContent, ['type' => 'text/javascript'], ['priority' => true]);
+        $this->assetCollector->addInlineJavaScript('underlyingQueryVar', $underlyingQueryScriptTagContent, ['type' => 'text/javascript'], ['priority' => true]);
 
         $this->addStandardAssignments();
         $defaultQuery = $this->searchProvider->getDefaultQuery();
@@ -149,13 +149,10 @@ protected function addStandardAssignments(): void
             $this->request->getAttribute('currentContentObject')->data['uid']
         );
         $this->searchProvider->setConfigurationValue('prefixID', 'tx_find_find');
-        $this->searchProvider->setConfigurationValue('pageTitle', $GLOBALS['TSFE']->page['title']);
+        $this->searchProvider->setConfigurationValue('pageTitle', $this->pageTitleProvider->getTitle());
     }
 
-    /**
-     * @param string $activeConnection
-     */
-    protected function initializeConnection($activeConnection): void
+    protected function initializeConnection(string $activeConnection): void
     {
         $connectionConfiguration = $this->settings['connections'][$activeConnection];
 

Classes/Service/AbstractServiceProvider.php

@@ -26,6 +26,8 @@
  *
  *  This copyright notice MUST APPEAR in all copies of the script!
  * ************************************************************* */
+
+use Psr\Log\LoggerInterface;
 use Solarium\Client;
 use Solarium\Component\Highlighting\Field;
 use Solarium\Core\Client\Adapter\Curl;
@@ -40,9 +42,9 @@
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 /**
- * Service provider for solr.
+ * Service provider for Solr.
  */
-class SolrServiceProvider extends AbstractServiceProvider
+class SolrServiceProvider implements ServiceProviderInterface
 {
     protected ?string $action = null;
 
@@ -54,6 +56,20 @@ class SolrServiceProvider extends AbstractServiceProvider
 
     protected Query $query;
 
+    protected array $requestArguments = [];
+
+    public function __construct(protected string $connectionName, protected array $settings, protected LoggerInterface $logger) {}
+
+    public function getRequestArguments(): array
+    {
+        return $this->requestArguments;
+    }
+
+    public function setRequestArguments(array $requestArguments): void
+    {
+        $this->requestArguments = $requestArguments;
+    }
+
     public function connect(): void
     {
         $currentConnectionSettings = $this->settings['connections'][$this->connectionName]['options'];
@@ -525,7 +541,7 @@ protected function addSortOrdersToTemplate(array $arguments): void
             ksort($this->settings['sort']);
             foreach ($this->settings['sort'] as $sortOptionIndex => $sortOption) {
                 if (array_key_exists('id', $sortOption) && array_key_exists('sortCriteria', $sortOption)) {
-                    $localisationKey = 'LLL:' . $this->settings['languageRootPath'] . 'locallang-form.xml:input.sort-' . $sortOption['id'];
+                    $localisationKey = 'LLL:' . $this->settings['languageRootPath'] . 'locallang-form.xlf:input.sort-' . $sortOption['id'];
                     $localisedLabel = LocalizationUtility::translate(
                         $localisationKey,
                         $this->getControllerExtensionKey()

Classes/Service/SolrServiceProvider.php

@@ -6,7 +6,7 @@
  *  Copyright notice
  *
  *  (c) 2015 Ingo Pfennigstorf <[email protected]>
- *      Goettingen State Library
+ *      Göttingen State Library
  *
  *  All rights reserved
  *
@@ -30,20 +30,23 @@
 class ArrayUtility
 {
     /**
-     * Removes all values from $array whose
-     * * keys begin with __
-     * * values are an empty string.
-     *
-     * Specifically aimed at the __hmac and __referrer keys introduced by Fluid
-     * forms as well as the text submitted by empty search form fields.
+     * Recursively cleans an arguments array:
+     * - Removes keys beginning with "__"
+     * - Removes elements that are empty strings
+     * Call this on $_GET, $_POST, or Extbase argument arrays before use.
      */
     public static function cleanArgumentsArray(array $array): array
     {
-        foreach ($array as $key => &$value) {
+        foreach ($array as $key => $value) {
             if (str_starts_with($key, '__') || $value === '') {
                 unset($array[$key]);
             } elseif (is_array($value)) {
-                self::cleanArgumentsArray($value);
+                $cleaned = self::cleanArgumentsArray($value);
+                if ($cleaned === []) {
+                    unset($array[$key]);
+                } else {
+                    $array[$key] = $cleaned;
+                }
             }
         }
 

Classes/Utility/ArrayUtility.php

@@ -6,7 +6,7 @@
  *  Copyright notice
  *
  *  (c) 2015 Ingo Pfennigstorf <[email protected]>
- *      Goettingen State Library
+ *      Göttingen State Library
  *
  *  All rights reserved
  *
@@ -28,41 +28,49 @@
  * ************************************************************* */
 
 /**
- * Utility for JavaScripts, Views, ...
+ * Utility for JavaScript and view helpers in the frontend.
  */
 class FrontendUtility
 {
     /**
-     * Stores information about the active query in the »underlyingQuery« JavaScript variable.
+     * Generates a JS assignment for the active query and its paging/facet data as `underlyingQuery` variable.
      *
-     * @param int|null $position  of the record in the result list
-     * @param array $arguments overrides $this->requestArguments if set
+     * @param mixed        $query      Query parameter(s) (string or array, depending on your usage)
+     * @param array        $settings   Complete plugin or extension settings
+     * @param int|null     $position   Position in result list (1-based, null if not applicable)
+     * @param array        $arguments  Arguments array (request arguments or override)
+     * @return string                  JS assignment or empty string
      *
      * @throws \JsonException
      */
-    public static function addQueryInformationAsJavaScript($query, array $settings, ?int $position = null, array $arguments = []): string
-    {
-        if ($settings['paging']['detailPagePaging']) {
-            if (array_key_exists('underlyingQuery', $arguments)) {
+    public static function addQueryInformationAsJavaScript(
+        $query,
+        array $settings,
+        ?int $position = null,
+        array $arguments = []
+    ): string {
+        if (!empty($settings['paging']['detailPagePaging'])) {
+            // If the arguments contain an 'underlyingQuery' sub-array, use it
+            if (array_key_exists('underlyingQuery', $arguments) && is_array($arguments['underlyingQuery'])) {
                 $arguments = $arguments['underlyingQuery'];
             }
 
             $underlyingQuery = ['q' => $query];
-            if (array_key_exists('facet', $arguments)) {
+            if (!empty($arguments['facet'])) {
                 $underlyingQuery['facet'] = $arguments['facet'];
             }
 
             if ($position !== null) {
                 $underlyingQuery['position'] = $position;
             }
 
-            if (array_key_exists('count', $arguments)) {
+            if (isset($arguments['count'])) {
                 $underlyingQuery['count'] = $arguments['count'];
-            } elseif (array_key_exists('count', $settings)) {
+            } elseif (isset($settings['count'])) {
                 $underlyingQuery['count'] = $settings['count'];
             }
 
-            if (array_key_exists('sort', $arguments)) {
+            if (isset($arguments['sort'])) {
                 $underlyingQuery['sort'] = $arguments['sort'];
             }
 
@@ -72,8 +80,22 @@ public static function addQueryInformationAsJavaScript($query, array $settings,
         return '';
     }
 
+    /**
+     * Calculates index values for detail navigation based on a position key.
+     *
+     * @param array $underlyingQueryInfo Array including at least a 'position' key (1-based).
+     * @return array Index info: positionIndex, previousIndex, nextIndex, resultIndexOffset
+     */
     public static function getIndexes(array $underlyingQueryInfo): array
     {
-        return ['positionIndex' => $underlyingQueryInfo['position'] - 1, 'previousIndex' => max([$underlyingQueryInfo['position'] - 2, 0]), 'nextIndex' => $underlyingQueryInfo['position'], 'resultIndexOffset' => (0 === $underlyingQueryInfo['position'] - 1) ? 0 : 1];
+        // Default to position=1 if missing
+        $position = (int)($underlyingQueryInfo['position'] ?? 1);
+
+        return [
+            'positionIndex' => $position - 1,
+            'previousIndex' => max($position - 2, 0),
+            'nextIndex' => $position,
+            'resultIndexOffset' => ($position - 1 === 0) ? 0 : 1,
+        ];
     }
 }

Classes/Utility/FrontendUtility.php

@@ -2,12 +2,13 @@ mod.wizards.newContentElement.wizardItems.plugins {
     elements {
         find {
             iconIdentifier = ext-find-ce-wizard
-            title = LLL:EXT:find/Resources/Private/Language/locallang_be.xml:ce.title
-            description = LLL:EXT:find/Resources/Private/Language/locallang_be.xml:ce.description
+            title = LLL:EXT:find/Resources/Private/Language/locallang_be.xlf:ce.title
+            description = LLL:EXT:find/Resources/Private/Language/locallang_be.xlf:ce.description
             tt_content_defValues {
                 CType = list
                 list_type = find_find
             }
         }
     }
+    show := addToList(find)
 }